@aws-sdk/client-connect 3.974.0 → 3.977.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 (93) hide show
  1. package/README.md +77 -0
  2. package/dist-cjs/index.js +561 -26
  3. package/dist-es/Connect.js +22 -0
  4. package/dist-es/commands/CreateTestCaseCommand.js +16 -0
  5. package/dist-es/commands/DeleteTestCaseCommand.js +16 -0
  6. package/dist-es/commands/DescribeTestCaseCommand.js +16 -0
  7. package/dist-es/commands/GetTestCaseExecutionSummaryCommand.js +16 -0
  8. package/dist-es/commands/ListTestCaseExecutionRecordsCommand.js +16 -0
  9. package/dist-es/commands/ListTestCaseExecutionsCommand.js +16 -0
  10. package/dist-es/commands/ListTestCasesCommand.js +16 -0
  11. package/dist-es/commands/SearchTestCasesCommand.js +16 -0
  12. package/dist-es/commands/StartTestCaseExecutionCommand.js +16 -0
  13. package/dist-es/commands/StopTestCaseExecutionCommand.js +16 -0
  14. package/dist-es/commands/UpdateTestCaseCommand.js +16 -0
  15. package/dist-es/commands/index.js +11 -0
  16. package/dist-es/models/enums.js +20 -0
  17. package/dist-es/models/errors.js +14 -0
  18. package/dist-es/pagination/ListTestCasesPaginator.js +4 -0
  19. package/dist-es/pagination/SearchTestCasesPaginator.js +4 -0
  20. package/dist-es/pagination/index.js +2 -0
  21. package/dist-es/schemas/schemas_0.js +319 -27
  22. package/dist-types/Connect.d.ts +77 -0
  23. package/dist-types/ConnectClient.d.ts +13 -2
  24. package/dist-types/commands/CreateTestCaseCommand.d.ts +127 -0
  25. package/dist-types/commands/CreateWorkspacePageCommand.d.ts +1 -1
  26. package/dist-types/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
  27. package/dist-types/commands/DeleteTestCaseCommand.d.ts +91 -0
  28. package/dist-types/commands/DescribeTestCaseCommand.d.ts +116 -0
  29. package/dist-types/commands/GetTestCaseExecutionSummaryCommand.d.ts +101 -0
  30. package/dist-types/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +2 -1
  31. package/dist-types/commands/ListApprovedOriginsCommand.d.ts +1 -1
  32. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +1 -1
  33. package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +1 -1
  34. package/dist-types/commands/ListBotsCommand.d.ts +1 -1
  35. package/dist-types/commands/ListTestCaseExecutionRecordsCommand.d.ts +105 -0
  36. package/dist-types/commands/ListTestCaseExecutionsCommand.d.ts +111 -0
  37. package/dist-types/commands/ListTestCasesCommand.d.ts +104 -0
  38. package/dist-types/commands/SearchTestCasesCommand.d.ts +167 -0
  39. package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
  40. package/dist-types/commands/SendOutboundEmailCommand.d.ts +1 -1
  41. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +1 -1
  42. package/dist-types/commands/StartChatContactCommand.d.ts +1 -2
  43. package/dist-types/commands/StartTaskContactCommand.d.ts +6 -0
  44. package/dist-types/commands/StartTestCaseExecutionCommand.d.ts +99 -0
  45. package/dist-types/commands/StopTestCaseExecutionCommand.d.ts +93 -0
  46. package/dist-types/commands/UpdateTestCaseCommand.d.ts +112 -0
  47. package/dist-types/commands/index.d.ts +11 -0
  48. package/dist-types/models/enums.d.ts +52 -0
  49. package/dist-types/models/errors.d.ts +17 -0
  50. package/dist-types/models/models_0.d.ts +113 -84
  51. package/dist-types/models/models_1.d.ts +267 -282
  52. package/dist-types/models/models_2.d.ts +578 -599
  53. package/dist-types/models/models_3.d.ts +795 -3
  54. package/dist-types/pagination/ListTestCasesPaginator.d.ts +7 -0
  55. package/dist-types/pagination/SearchTestCasesPaginator.d.ts +7 -0
  56. package/dist-types/pagination/index.d.ts +2 -0
  57. package/dist-types/schemas/schemas_0.d.ts +44 -0
  58. package/dist-types/ts3.4/Connect.d.ts +187 -0
  59. package/dist-types/ts3.4/ConnectClient.d.ts +66 -0
  60. package/dist-types/ts3.4/commands/CreateTestCaseCommand.d.ts +50 -0
  61. package/dist-types/ts3.4/commands/CreateWorkspacePageCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/DeactivateEvaluationFormCommand.d.ts +1 -1
  63. package/dist-types/ts3.4/commands/DeleteTestCaseCommand.d.ts +50 -0
  64. package/dist-types/ts3.4/commands/DescribeTestCaseCommand.d.ts +50 -0
  65. package/dist-types/ts3.4/commands/GetTestCaseExecutionSummaryCommand.d.ts +51 -0
  66. package/dist-types/ts3.4/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +2 -4
  67. package/dist-types/ts3.4/commands/ListApprovedOriginsCommand.d.ts +1 -1
  68. package/dist-types/ts3.4/commands/ListAssociatedContactsCommand.d.ts +1 -1
  69. package/dist-types/ts3.4/commands/ListAuthenticationProfilesCommand.d.ts +1 -1
  70. package/dist-types/ts3.4/commands/ListBotsCommand.d.ts +1 -1
  71. package/dist-types/ts3.4/commands/ListTestCaseExecutionRecordsCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/ListTestCaseExecutionsCommand.d.ts +51 -0
  73. package/dist-types/ts3.4/commands/ListTestCasesCommand.d.ts +50 -0
  74. package/dist-types/ts3.4/commands/SearchTestCasesCommand.d.ts +48 -0
  75. package/dist-types/ts3.4/commands/SendChatIntegrationEventCommand.d.ts +1 -1
  76. package/dist-types/ts3.4/commands/SendOutboundEmailCommand.d.ts +1 -1
  77. package/dist-types/ts3.4/commands/StartAttachedFileUploadCommand.d.ts +1 -1
  78. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +4 -2
  79. package/dist-types/ts3.4/commands/StartTestCaseExecutionCommand.d.ts +51 -0
  80. package/dist-types/ts3.4/commands/StopTestCaseExecutionCommand.d.ts +51 -0
  81. package/dist-types/ts3.4/commands/UpdateTestCaseCommand.d.ts +50 -0
  82. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  83. package/dist-types/ts3.4/models/enums.d.ts +28 -0
  84. package/dist-types/ts3.4/models/errors.d.ts +8 -0
  85. package/dist-types/ts3.4/models/models_0.d.ts +28 -19
  86. package/dist-types/ts3.4/models/models_1.d.ts +65 -67
  87. package/dist-types/ts3.4/models/models_2.d.ts +137 -121
  88. package/dist-types/ts3.4/models/models_3.d.ts +172 -10
  89. package/dist-types/ts3.4/pagination/ListTestCasesPaginator.d.ts +11 -0
  90. package/dist-types/ts3.4/pagination/SearchTestCasesPaginator.d.ts +11 -0
  91. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  92. package/dist-types/ts3.4/schemas/schemas_0.d.ts +44 -0
  93. package/package.json +17 -17
@@ -1,7 +1,585 @@
1
- import { AgentAvailabilityTimer, AgentStatusState, AnsweringMachineDetectionStatus, Channel, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactMediaProcessingFailureMode, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DisconnectOnCustomerExitParticipantType, EmailHeaderType, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormQuestionType, EvaluationFormVersionStatus, InboundMessageSourceType, InitiateAs, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, MeetingFeatureStatus, OverrideType, ParticipantTimerAction, ParticipantTimerType, QueueStatus, RoutingCriteriaStepStatus, RulePublishStatus, SearchableQueueType, TaskTemplateStatus, TimerEligibleParticipantRoles, TrafficType, ViewStatus, ViewType, Visibility, VoiceRecordingTrack } from "./enums";
2
- import { type AdditionalEmailRecipients, type AgentConfig, type AgentInfo, type AgentStatusSearchFilter, type AllowedCapabilities, type Campaign, type DataTableLockVersion, type Endpoint, type EvaluationFormAutoEvaluationConfiguration, type EvaluationFormLanguageConfiguration, type EvaluationFormQuestionTypeProperties, type EvaluationFormScoringStrategy, type EvaluationFormTargetConfiguration, type EvaluationReviewConfiguration, type GranularAccessControlConfiguration, type InputPredefinedAttributeConfiguration, type InstanceStorageConfig, type OutboundCallerConfig, type OutboundEmailConfig, type OutboundStrategy, type PredefinedAttributeValues, type QuickConnectConfig, type RecurrenceConfig, type StringCondition, type TaskTemplateConstraints, type TaskTemplateDefaults, type UserIdentityInfo, type UserInfo, type UserPhoneConfig, type Validation, type View, type ViewInputContent, type WorkspaceTheme, Application, EvaluationFormItemEnablementExpression, FlowModule, HoursOfOperationConfig, HoursOfOperationOverrideConfig, MediaConcurrency, PrimaryValue, Reference, RoutingProfileQueueConfig, RuleAction, TaskTemplateField, UserProficiency } from "./models_0";
1
+ import { AgentAvailabilityTimer, AgentStatusState, AnsweringMachineDetectionStatus, Channel, ChatEventType, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactMediaProcessingFailureMode, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DisconnectOnCustomerExitParticipantType, EmailHeaderType, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormQuestionType, EvaluationFormVersionStatus, FileStatusType, FileUseCaseType, InboundMessageSourceType, InitiateAs, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, MeetingFeatureStatus, OutboundMessageSourceType, OverrideType, ParticipantTimerAction, ParticipantTimerType, QueueStatus, RehydrationType, ResponseMode, RoutingCriteriaStepStatus, RulePublishStatus, SearchableQueueType, TaskTemplateStatus, TestCaseExecutionStatus, TestCaseStatus, TimerEligibleParticipantRoles, TrafficType, ViewStatus, ViewType, Visibility, VoiceRecordingTrack } from "./enums";
2
+ import { type AdditionalEmailRecipients, type AgentConfig, type AgentInfo, type AgentStatusSearchFilter, type AllowedCapabilities, type Campaign, type CreatedByInfo, type DataTableLockVersion, type Endpoint, type EvaluationFormAutoEvaluationConfiguration, type EvaluationFormLanguageConfiguration, type EvaluationFormQuestionTypeProperties, type EvaluationFormScoringStrategy, type EvaluationFormTargetConfiguration, type EvaluationReviewConfiguration, type GranularAccessControlConfiguration, type InputPredefinedAttributeConfiguration, type InstanceStorageConfig, type OutboundCallerConfig, type OutboundEmailConfig, type OutboundStrategy, type PredefinedAttributeValues, type QuickConnectConfig, type RecurrenceConfig, type StringCondition, type TaskTemplateConstraints, type TaskTemplateDefaults, type TestCaseEntryPoint, type UserIdentityInfo, type UserInfo, type UserPhoneConfig, type Validation, type View, type ViewInputContent, type WorkspaceTheme, Application, EvaluationFormItemEnablementExpression, FlowModule, HoursOfOperationConfig, HoursOfOperationOverrideConfig, MediaConcurrency, PrimaryValue, Reference, RoutingProfileQueueConfig, RuleAction, TaskTemplateField, UserProficiency } from "./models_0";
3
3
  import { type AttributeCondition, type ChatMetrics, type ContactDetails, type Customer, type CustomerVoiceActivity, type DisconnectDetails, type EndpointInfo, type Evaluation, type EvaluationAnswerData, type Expiry, type GlobalResiliencyMetadata, type QualityMetrics, type QueueInfo, type SignInConfig, type TaskTemplateInfoV2, type TelephonyConfig, type WisdomInfo, ContactEvaluation, EvaluationNote, NextContactEntry, RecordingInfo } from "./models_1";
4
- import { type AutoEvaluationConfiguration, type BooleanCondition, type ChatMessage, type ChatStreamingConfiguration, type ContactFlowModuleSearchFilter, type ContactFlowSearchFilter, type ContactSearchSummaryAgentInfo, type ContactSearchSummaryQueueInfo, type DataTableSearchFilter, type DateCondition, type DateTimeCondition, type DecimalCondition, type EmailAddressSearchFilter, type EvaluationFormSearchFilter, type EvaluationSearchFilter, type HierarchyGroupCondition, type HoursOfOperationSearchFilter, type ListCondition, type NumberCondition, type OutboundAdditionalRecipients, type OutboundEmailContent, type ParticipantConfiguration, type ParticipantDetails, type PersistentChat, type PromptSearchFilter, type QueueSearchFilter, type QuickConnectSearchFilter, type RoutingProfileSearchFilter, type SecurityProfilesSearchFilter, type TemplatedMessageConfig, type UserHierarchyGroupSearchFilter, type UserSearchFilter, type ViewSearchFilter, type WorkspaceAssociationSearchFilter, type WorkspaceSearchFilter, EmailAddressInfo } from "./models_2";
4
+ import type { BooleanCondition, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, ContactSearchSummaryAgentInfo, ContactSearchSummaryQueueInfo, DataTableSearchFilter, DateCondition, DateTimeCondition, DecimalCondition, EmailAddressSearchFilter, EvaluationFormSearchFilter, EvaluationSearchFilter, HierarchyGroupCondition, HoursOfOperationSearchFilter, ListCondition, NumberCondition, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingProfileSearchFilter, SecurityProfilesSearchFilter, TestCaseSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter, ViewSearchFilter, WorkspaceAssociationSearchFilter, WorkspaceSearchFilter } from "./models_2";
5
+ /**
6
+ * <p>Chat integration event containing payload to perform different chat actions such as:</p>
7
+ * <ul>
8
+ * <li>
9
+ * <p>Sending a chat message</p>
10
+ * </li>
11
+ * <li>
12
+ * <p>Sending a chat event, such as typing</p>
13
+ * </li>
14
+ * <li>
15
+ * <p>Disconnecting from a chat</p>
16
+ * </li>
17
+ * </ul>
18
+ * @public
19
+ */
20
+ export interface ChatEvent {
21
+ /**
22
+ * <p>Type of chat integration event. </p>
23
+ * @public
24
+ */
25
+ Type: ChatEventType | undefined;
26
+ /**
27
+ * <p>Type of content. This is required when <code>Type</code> is <code>MESSAGE</code> or <code>EVENT</code>. </p>
28
+ * <ul>
29
+ * <li>
30
+ * <p>For allowed message content types, see the <code>ContentType</code> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic
31
+ * in the <i>Amazon Connect Participant Service API Reference</i>.</p>
32
+ * </li>
33
+ * <li>
34
+ * <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 Reference</i>. </p>
35
+ * </li>
36
+ * </ul>
37
+ * @public
38
+ */
39
+ ContentType?: string | undefined;
40
+ /**
41
+ * <p>Content of the message or event. This is required when <code>Type</code> is <code>MESSAGE</code> and for certain
42
+ * <code>ContentTypes</code> when <code>Type</code> is <code>EVENT</code>.</p>
43
+ * <ul>
44
+ * <li>
45
+ * <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
46
+ * <i>Amazon Connect Participant Service API Reference</i>.</p>
47
+ * </li>
48
+ * <li>
49
+ * <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 Reference</i>. </p>
50
+ * </li>
51
+ * </ul>
52
+ * @public
53
+ */
54
+ Content?: string | undefined;
55
+ }
56
+ /**
57
+ * <p>The customer's details.</p>
58
+ * @public
59
+ */
60
+ export interface ParticipantDetails {
61
+ /**
62
+ * <p>Display name of the participant.</p>
63
+ * @public
64
+ */
65
+ DisplayName: string | undefined;
66
+ }
67
+ /**
68
+ * <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
69
+ * @public
70
+ */
71
+ export interface ChatStreamingConfiguration {
72
+ /**
73
+ * <p>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish
74
+ * real-time message streaming for chat conversations.</p>
75
+ * @public
76
+ */
77
+ StreamingEndpointArn: string | undefined;
78
+ }
79
+ /**
80
+ * <p>Payload of chat properties to apply when starting a new contact.</p>
81
+ * @public
82
+ */
83
+ export interface NewSessionDetails {
84
+ /**
85
+ * <p> The supported chat message content types. Supported types are <code>text/plain</code>,
86
+ * <code>text/markdown</code>, <code>application/json</code>,
87
+ * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
88
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
89
+ * <p>Content types must always contain <code> text/plain</code>. You can then put any other supported type in the
90
+ * list. For example, all the following lists are valid because they contain <code>text/plain</code>: <code>[text/plain,
91
+ * text/markdown, application/json]</code>, <code> [text/markdown, text/plain]</code>, <code>[text/plain,
92
+ * application/json, application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
93
+ * @public
94
+ */
95
+ SupportedMessagingContentTypes?: string[] | undefined;
96
+ /**
97
+ * <p>The customer's details.</p>
98
+ * @public
99
+ */
100
+ ParticipantDetails?: ParticipantDetails | undefined;
101
+ /**
102
+ * <p> A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They
103
+ * can be accessed in flows just like any other contact attributes. </p>
104
+ * <p> There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
105
+ * alphanumeric, dash, and underscore characters. </p>
106
+ * @public
107
+ */
108
+ Attributes?: Record<string, string> | undefined;
109
+ /**
110
+ * <p>The streaming configuration, such as the Amazon SNS streaming endpoint.</p>
111
+ * @public
112
+ */
113
+ StreamingConfiguration?: ChatStreamingConfiguration | undefined;
114
+ }
115
+ /**
116
+ * @public
117
+ */
118
+ export interface SendChatIntegrationEventRequest {
119
+ /**
120
+ * <p>External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the
121
+ * E164 phone number of the chat customer participant.</p>
122
+ * @public
123
+ */
124
+ SourceId: string | undefined;
125
+ /**
126
+ * <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect
127
+ * instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound
128
+ * Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.</p>
129
+ * @public
130
+ */
131
+ DestinationId: string | undefined;
132
+ /**
133
+ * <p>Classification of a channel. This is used in part to uniquely identify chat. </p>
134
+ * <p>Valid value: <code>["connect:sms", connect:"WhatsApp"]</code>
135
+ * </p>
136
+ * @public
137
+ */
138
+ Subtype?: string | undefined;
139
+ /**
140
+ * <p>Chat integration event payload</p>
141
+ * @public
142
+ */
143
+ Event: ChatEvent | undefined;
144
+ /**
145
+ * <p>Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat,
146
+ * this is ignored.</p>
147
+ * @public
148
+ */
149
+ NewSessionDetails?: NewSessionDetails | undefined;
150
+ }
151
+ /**
152
+ * @public
153
+ */
154
+ export interface SendChatIntegrationEventResponse {
155
+ /**
156
+ * <p>Identifier of chat contact used to handle integration event. This may be null if the integration event is not
157
+ * valid without an already existing chat contact.</p>
158
+ * @public
159
+ */
160
+ InitialContactId?: string | undefined;
161
+ /**
162
+ * <p>Whether handling the integration event resulted in creating a new chat or acting on existing chat.</p>
163
+ * @public
164
+ */
165
+ NewChatCreated?: boolean | undefined;
166
+ }
167
+ /**
168
+ * <p>Contains information about a source or destination email address.</p>
169
+ * @public
170
+ */
171
+ export interface EmailAddressInfo {
172
+ /**
173
+ * <p>The email address, including the domain.</p>
174
+ * @public
175
+ */
176
+ EmailAddress: string | undefined;
177
+ /**
178
+ * <p>The display name of email address.</p>
179
+ * @public
180
+ */
181
+ DisplayName?: string | undefined;
182
+ }
183
+ /**
184
+ * <p>Information about the additional recipients of outbound email.</p>
185
+ * @public
186
+ */
187
+ export interface OutboundAdditionalRecipients {
188
+ /**
189
+ * <p>Information about the <b>additional</b> CC email address recipients. Email recipients
190
+ * are limited to 50 total addresses: 1 required recipient in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SendOutboundEmail.html#API_SendOutboundEmail_RequestBody">DestinationEmailAddress</a> field and up to 49 recipients in the 'CcEmailAddresses' field.</p>
191
+ * @public
192
+ */
193
+ CcEmailAddresses?: EmailAddressInfo[] | undefined;
194
+ }
195
+ /**
196
+ * <p>Information about the raw email body content.</p>
197
+ * @public
198
+ */
199
+ export interface OutboundRawMessage {
200
+ /**
201
+ * <p>The email subject.</p>
202
+ * @public
203
+ */
204
+ Subject: string | undefined;
205
+ /**
206
+ * <p>The email message body.</p>
207
+ * @public
208
+ */
209
+ Body: string | undefined;
210
+ /**
211
+ * <p>Type of content, that is, <code>text/plain</code> or <code>text/html</code>.</p>
212
+ * @public
213
+ */
214
+ ContentType: string | undefined;
215
+ }
216
+ /**
217
+ * <p>Information about the template attributes.</p>
218
+ * @public
219
+ */
220
+ export interface TemplateAttributes {
221
+ /**
222
+ * <p>An object that specifies the custom attributes values to use for variables in the message template. This object
223
+ * contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template.
224
+ * </p>
225
+ * @public
226
+ */
227
+ CustomAttributes?: Record<string, string> | undefined;
228
+ /**
229
+ * <p>An object that specifies the customer profile attributes values to use for variables in the message template.
230
+ * This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the
231
+ * message template. </p>
232
+ * @public
233
+ */
234
+ CustomerProfileAttributes?: string | undefined;
235
+ }
236
+ /**
237
+ * <p>Information about template message configuration.</p>
238
+ * @public
239
+ */
240
+ export interface TemplatedMessageConfig {
241
+ /**
242
+ * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
243
+ * @public
244
+ */
245
+ KnowledgeBaseId: string | undefined;
246
+ /**
247
+ * <p>The identifier of the message template Id.</p>
248
+ * @public
249
+ */
250
+ MessageTemplateId: string | undefined;
251
+ /**
252
+ * <p>Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes.</p>
253
+ * @public
254
+ */
255
+ TemplateAttributes: TemplateAttributes | undefined;
256
+ }
257
+ /**
258
+ * <p>Information about email body content.</p>
259
+ * @public
260
+ */
261
+ export interface OutboundEmailContent {
262
+ /**
263
+ * <p>The message source type, that is, <code>RAW</code> or <code>TEMPLATE</code>.</p>
264
+ * @public
265
+ */
266
+ MessageSourceType: OutboundMessageSourceType | undefined;
267
+ /**
268
+ * <p>Information about template message configuration.</p>
269
+ * @public
270
+ */
271
+ TemplatedMessageConfig?: TemplatedMessageConfig | undefined;
272
+ /**
273
+ * <p>The raw email body content.</p>
274
+ * @public
275
+ */
276
+ RawMessage?: OutboundRawMessage | undefined;
277
+ }
278
+ /**
279
+ * <p>Information about the campaign.</p>
280
+ * @public
281
+ */
282
+ export interface SourceCampaign {
283
+ /**
284
+ * <p>A unique identifier for a campaign.</p>
285
+ * @public
286
+ */
287
+ CampaignId?: string | undefined;
288
+ /**
289
+ * <p>A unique identifier for a each request part of same campaign.</p>
290
+ * @public
291
+ */
292
+ OutboundRequestId?: string | undefined;
293
+ }
294
+ /**
295
+ * @public
296
+ */
297
+ export interface SendOutboundEmailRequest {
298
+ /**
299
+ * <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>
300
+ * @public
301
+ */
302
+ InstanceId: string | undefined;
303
+ /**
304
+ * <p>The email address to be used for sending email.</p>
305
+ * @public
306
+ */
307
+ FromEmailAddress: EmailAddressInfo | undefined;
308
+ /**
309
+ * <p>The email address to send the email to.</p>
310
+ * @public
311
+ */
312
+ DestinationEmailAddress: EmailAddressInfo | undefined;
313
+ /**
314
+ * <p>The additional recipients address of the email in CC.</p>
315
+ * @public
316
+ */
317
+ AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
318
+ /**
319
+ * <p>The email message body to be sent to the newly created email.</p>
320
+ * @public
321
+ */
322
+ EmailMessage: OutboundEmailContent | undefined;
323
+ /**
324
+ * <p>Denotes the class of traffic.</p>
325
+ * <note>
326
+ * <p>Only the CAMPAIGN traffic type is supported.</p>
327
+ * </note>
328
+ * @public
329
+ */
330
+ TrafficType: TrafficType | undefined;
331
+ /**
332
+ * <p>A Campaign object need for Campaign traffic type.</p>
333
+ * @public
334
+ */
335
+ SourceCampaign?: SourceCampaign | undefined;
336
+ /**
337
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
338
+ * request. If not provided, the Amazon Web Services
339
+ * SDK populates this field. For more information about idempotency, see
340
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
341
+ * @public
342
+ */
343
+ ClientToken?: string | undefined;
344
+ }
345
+ /**
346
+ * @public
347
+ */
348
+ export interface SendOutboundEmailResponse {
349
+ }
350
+ /**
351
+ * @public
352
+ */
353
+ export interface StartAttachedFileUploadRequest {
354
+ /**
355
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
356
+ * request. If not provided, the Amazon Web Services
357
+ * SDK populates this field. For more information about idempotency, see
358
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
359
+ * @public
360
+ */
361
+ ClientToken?: string | undefined;
362
+ /**
363
+ * <p>The unique identifier of the Amazon Connect instance.</p>
364
+ * @public
365
+ */
366
+ InstanceId: string | undefined;
367
+ /**
368
+ * <p>A case-sensitive name of the attached file being uploaded.</p>
369
+ * @public
370
+ */
371
+ FileName: string | undefined;
372
+ /**
373
+ * <p>The size of the attached file in bytes.</p>
374
+ * @public
375
+ */
376
+ FileSizeInBytes: number | undefined;
377
+ /**
378
+ * <p>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</p>
379
+ * @public
380
+ */
381
+ UrlExpiryInSeconds?: number | undefined;
382
+ /**
383
+ * <p>The use case for the file.</p>
384
+ * <important>
385
+ * <p> Only <code>ATTACHMENTS</code> are supported.</p>
386
+ * </important>
387
+ * @public
388
+ */
389
+ FileUseCaseType: FileUseCaseType | undefined;
390
+ /**
391
+ * <p>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</p>
392
+ * <note>
393
+ * <p>This value must be a valid ARN.</p>
394
+ * </note>
395
+ * @public
396
+ */
397
+ AssociatedResourceArn: string | undefined;
398
+ /**
399
+ * <p>Represents the identity that created the file.</p>
400
+ * @public
401
+ */
402
+ CreatedBy?: CreatedByInfo | undefined;
403
+ /**
404
+ * <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags":
405
+ * \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
406
+ * @public
407
+ */
408
+ Tags?: Record<string, string> | undefined;
409
+ }
410
+ /**
411
+ * <p>Fields required when uploading an attached file. </p>
412
+ * @public
413
+ */
414
+ export interface UploadUrlMetadata {
415
+ /**
416
+ * <p>A pre-signed S3 URL that should be used for uploading the attached file. </p>
417
+ * @public
418
+ */
419
+ Url?: string | undefined;
420
+ /**
421
+ * <p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
422
+ * <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2019-11-08T02:41:28.172Z</code>.</p>
423
+ * @public
424
+ */
425
+ UrlExpiry?: string | undefined;
426
+ /**
427
+ * <p>A map of headers that should be provided when uploading the attached file. </p>
428
+ * @public
429
+ */
430
+ HeadersToInclude?: Record<string, string> | undefined;
431
+ }
432
+ /**
433
+ * Response from StartAttachedFileUpload API.
434
+ * @public
435
+ */
436
+ export interface StartAttachedFileUploadResponse {
437
+ /**
438
+ * <p>The unique identifier of the attached file resource (ARN).</p>
439
+ * @public
440
+ */
441
+ FileArn?: string | undefined;
442
+ /**
443
+ * <p>The unique identifier of the attached file resource.</p>
444
+ * @public
445
+ */
446
+ FileId?: string | undefined;
447
+ /**
448
+ * <p>The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
449
+ * <code>yyyy-MM-ddThh:mm:ss.SSSZ</code>. For example, <code>2024-05-03T02:41:28.172Z</code>.</p>
450
+ * @public
451
+ */
452
+ CreationTime?: string | undefined;
453
+ /**
454
+ * <p>The current status of the attached file.</p>
455
+ * @public
456
+ */
457
+ FileStatus?: FileStatusType | undefined;
458
+ /**
459
+ * <p>Represents the identity that created the file.</p>
460
+ * @public
461
+ */
462
+ CreatedBy?: CreatedByInfo | undefined;
463
+ /**
464
+ * <p>The headers to be provided while uploading the file to the URL.</p>
465
+ * @public
466
+ */
467
+ UploadUrlMetadata?: UploadUrlMetadata | undefined;
468
+ }
469
+ /**
470
+ * <p>A chat message.</p>
471
+ * @public
472
+ */
473
+ export interface ChatMessage {
474
+ /**
475
+ * <p>The type of the content. Supported types are <code>text/plain</code>, <code>text/markdown</code>,
476
+ * <code>application/json</code>, and
477
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
478
+ * @public
479
+ */
480
+ ContentType: string | undefined;
481
+ /**
482
+ * <p>The content of the chat message. </p>
483
+ * <ul>
484
+ * <li>
485
+ * <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length Constraints are Minimum of 1, Maximum
486
+ * of 1024. </p>
487
+ * </li>
488
+ * <li>
489
+ * <p>For <code>application/json</code>, the Length Constraints are Minimum of 1, Maximum of 12000. </p>
490
+ * </li>
491
+ * <li>
492
+ * <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length Constraints are
493
+ * Minimum of 1, Maximum of 12288.</p>
494
+ * </li>
495
+ * </ul>
496
+ * @public
497
+ */
498
+ Content: string | undefined;
499
+ }
500
+ /**
501
+ * <p> The configuration of the participant. </p>
502
+ * @public
503
+ */
504
+ export interface ParticipantConfiguration {
505
+ /**
506
+ * <p> The mode in which responses should be sent to the participant. </p>
507
+ * @public
508
+ */
509
+ ResponseMode?: ResponseMode | undefined;
510
+ }
511
+ /**
512
+ * <p>Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how
513
+ * to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable
514
+ * persistent chat</a>.</p>
515
+ * @public
516
+ */
517
+ export interface PersistentChat {
518
+ /**
519
+ * <p>The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for
520
+ * persistent chat. </p>
521
+ * <ul>
522
+ * <li>
523
+ * <p>
524
+ * <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat contact of the
525
+ * specified past ended chat session. To use this type, provide the <code>initialContactId</code> of the past ended
526
+ * chat session in the <code>sourceContactId</code> field. In this type, Amazon Connect determines the most recent
527
+ * chat contact on the specified chat session that has ended, and uses it to start a persistent chat. </p>
528
+ * </li>
529
+ * <li>
530
+ * <p>
531
+ * <code>FROM_SEGMENT</code>: Rehydrates a chat from the past chat contact that is specified in the
532
+ * <code>sourceContactId</code> field. </p>
533
+ * </li>
534
+ * </ul>
535
+ * <p>The actual contactId used for rehydration is provided in the response of this API. </p>
536
+ * @public
537
+ */
538
+ RehydrationType?: RehydrationType | undefined;
539
+ /**
540
+ * <p>The contactId from which a persistent chat session must be started.</p>
541
+ * @public
542
+ */
543
+ SourceContactId?: string | undefined;
544
+ }
545
+ /**
546
+ * @public
547
+ */
548
+ export interface StartChatContactResponse {
549
+ /**
550
+ * <p>The identifier of this contact within the Amazon Connect instance. </p>
551
+ * @public
552
+ */
553
+ ContactId?: string | undefined;
554
+ /**
555
+ * <p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat
556
+ * lifecycle.</p>
557
+ * @public
558
+ */
559
+ ParticipantId?: string | undefined;
560
+ /**
561
+ * <p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat participant.</p>
562
+ * @public
563
+ */
564
+ ParticipantToken?: string | undefined;
565
+ /**
566
+ * <p>The contactId from which a persistent chat session is started. This field is populated only for persistent
567
+ * chats.</p>
568
+ * @public
569
+ */
570
+ ContinuedFromContactId?: string | undefined;
571
+ }
572
+ /**
573
+ * <p>Configuration information about automated evaluations.</p>
574
+ * @public
575
+ */
576
+ export interface AutoEvaluationConfiguration {
577
+ /**
578
+ * <p>Whether automated evaluations are enabled.</p>
579
+ * @public
580
+ */
581
+ Enabled: boolean | undefined;
582
+ }
5
583
  /**
6
584
  * @public
7
585
  */
@@ -496,6 +1074,22 @@ export interface StartScreenSharingRequest {
496
1074
  */
497
1075
  export interface StartScreenSharingResponse {
498
1076
  }
1077
+ /**
1078
+ * <p>Information about the task attachment files.</p>
1079
+ * @public
1080
+ */
1081
+ export interface TaskAttachment {
1082
+ /**
1083
+ * <p>A case-sensitive name of the attached file being uploaded.</p>
1084
+ * @public
1085
+ */
1086
+ FileName: string | undefined;
1087
+ /**
1088
+ * <p>The pre-signed URLs for the S3 bucket where the task attachment is stored.</p>
1089
+ * @public
1090
+ */
1091
+ S3Url: string | undefined;
1092
+ }
499
1093
  /**
500
1094
  * @public
501
1095
  */
@@ -506,6 +1100,49 @@ export interface StartTaskContactResponse {
506
1100
  */
507
1101
  ContactId?: string | undefined;
508
1102
  }
1103
+ /**
1104
+ * @public
1105
+ */
1106
+ export interface StartTestCaseExecutionRequest {
1107
+ /**
1108
+ * <p>The identifier of the Amazon Connect instance.</p>
1109
+ * @public
1110
+ */
1111
+ InstanceId: string | undefined;
1112
+ /**
1113
+ * <p>The identifier of the test case to execute.</p>
1114
+ * @public
1115
+ */
1116
+ TestCaseId: string | undefined;
1117
+ /**
1118
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1119
+ * request. If not provided, the Amazon Web Services
1120
+ * SDK populates this field. For more information about idempotency, see
1121
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1122
+ * @public
1123
+ */
1124
+ ClientToken?: string | undefined;
1125
+ }
1126
+ /**
1127
+ * @public
1128
+ */
1129
+ export interface StartTestCaseExecutionResponse {
1130
+ /**
1131
+ * <p>The identifier of the test case execution.</p>
1132
+ * @public
1133
+ */
1134
+ TestCaseExecutionId?: string | undefined;
1135
+ /**
1136
+ * <p>The identifier of the test case resource that was executed.</p>
1137
+ * @public
1138
+ */
1139
+ TestCaseId?: string | undefined;
1140
+ /**
1141
+ * <p>The status of a test case execution.</p>
1142
+ * @public
1143
+ */
1144
+ Status?: TestCaseExecutionStatus | undefined;
1145
+ }
509
1146
  /**
510
1147
  * @public
511
1148
  */
@@ -829,6 +1466,39 @@ export interface StopContactStreamingRequest {
829
1466
  */
830
1467
  export interface StopContactStreamingResponse {
831
1468
  }
1469
+ /**
1470
+ * @public
1471
+ */
1472
+ export interface StopTestCaseExecutionRequest {
1473
+ /**
1474
+ * <p>The identifier of the Amazon Connect instance.</p>
1475
+ * @public
1476
+ */
1477
+ InstanceId: string | undefined;
1478
+ /**
1479
+ * <p>The identifier of the test case execution to stop.</p>
1480
+ * @public
1481
+ */
1482
+ TestCaseExecutionId: string | undefined;
1483
+ /**
1484
+ * <p>The identifier of the test case.</p>
1485
+ * @public
1486
+ */
1487
+ TestCaseId: string | undefined;
1488
+ /**
1489
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1490
+ * request. If not provided, the Amazon Web Services
1491
+ * SDK populates this field. For more information about idempotency, see
1492
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1493
+ * @public
1494
+ */
1495
+ ClientToken?: string | undefined;
1496
+ }
1497
+ /**
1498
+ * @public
1499
+ */
1500
+ export interface StopTestCaseExecutionResponse {
1501
+ }
832
1502
  /**
833
1503
  * <p>Information about input answers for a contact evaluation.</p>
834
1504
  * @public
@@ -2754,6 +3424,66 @@ export interface UpdateTaskTemplateResponse {
2754
3424
  */
2755
3425
  CreatedTime?: Date | undefined;
2756
3426
  }
3427
+ /**
3428
+ * @public
3429
+ */
3430
+ export interface UpdateTestCaseRequest {
3431
+ /**
3432
+ * <p>The identifier of the Amazon Connect instance.</p>
3433
+ * @public
3434
+ */
3435
+ InstanceId: string | undefined;
3436
+ /**
3437
+ * <p>The identifier of the test case to update.</p>
3438
+ * @public
3439
+ */
3440
+ TestCaseId: string | undefined;
3441
+ /**
3442
+ * <p>The JSON string that represents the content of the test.</p>
3443
+ * @public
3444
+ */
3445
+ Content?: string | undefined;
3446
+ /**
3447
+ * <p>Defines the starting point for your test.</p>
3448
+ * @public
3449
+ */
3450
+ EntryPoint?: TestCaseEntryPoint | undefined;
3451
+ /**
3452
+ * <p>Defines the test attributes for precise data representation.</p>
3453
+ * @public
3454
+ */
3455
+ InitializationData?: string | undefined;
3456
+ /**
3457
+ * <p>The name of the test case.</p>
3458
+ * @public
3459
+ */
3460
+ Name?: string | undefined;
3461
+ /**
3462
+ * <p>The description of the test case.</p>
3463
+ * @public
3464
+ */
3465
+ Description?: string | undefined;
3466
+ /**
3467
+ * <p>Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.</p>
3468
+ * @public
3469
+ */
3470
+ Status?: TestCaseStatus | undefined;
3471
+ /**
3472
+ * <p>The time at which the resource was last modified.</p>
3473
+ * @public
3474
+ */
3475
+ LastModifiedTime?: Date | undefined;
3476
+ /**
3477
+ * <p>The region in which the resource was last modified</p>
3478
+ * @public
3479
+ */
3480
+ LastModifiedRegion?: string | undefined;
3481
+ }
3482
+ /**
3483
+ * @public
3484
+ */
3485
+ export interface UpdateTestCaseResponse {
3486
+ }
2757
3487
  /**
2758
3488
  * @public
2759
3489
  */
@@ -3770,6 +4500,32 @@ export interface SegmentAttributeValue {
3770
4500
  */
3771
4501
  ValueArn?: string | undefined;
3772
4502
  }
4503
+ /**
4504
+ * <p>The search criteria to be used to return test cases.</p>
4505
+ * @public
4506
+ */
4507
+ export interface TestCaseSearchCriteria {
4508
+ /**
4509
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
4510
+ * @public
4511
+ */
4512
+ OrConditions?: TestCaseSearchCriteria[] | undefined;
4513
+ /**
4514
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
4515
+ * @public
4516
+ */
4517
+ AndConditions?: TestCaseSearchCriteria[] | undefined;
4518
+ /**
4519
+ * <p>A leaf node condition which can be used to specify a string condition.</p>
4520
+ * @public
4521
+ */
4522
+ StringCondition?: StringCondition | undefined;
4523
+ /**
4524
+ * <p>The status of the test case.</p>
4525
+ * @public
4526
+ */
4527
+ StatusCondition?: TestCaseStatus | undefined;
4528
+ }
3773
4529
  /**
3774
4530
  * <p>The search criteria to be used to return userHierarchyGroup.</p>
3775
4531
  * @public
@@ -4464,6 +5220,37 @@ export interface SearchSecurityProfilesRequest {
4464
5220
  */
4465
5221
  SearchFilter?: SecurityProfilesSearchFilter | undefined;
4466
5222
  }
5223
+ /**
5224
+ * @public
5225
+ */
5226
+ export interface SearchTestCasesRequest {
5227
+ /**
5228
+ * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>
5229
+ * @public
5230
+ */
5231
+ InstanceId: string | undefined;
5232
+ /**
5233
+ * <p>The token for the next set of results. Use the value returned in the previous
5234
+ * response in the next request to retrieve the next set of results.</p>
5235
+ * @public
5236
+ */
5237
+ NextToken?: string | undefined;
5238
+ /**
5239
+ * <p>The maximum number of results to return per page.</p>
5240
+ * @public
5241
+ */
5242
+ MaxResults?: number | undefined;
5243
+ /**
5244
+ * <p>Filters to be applied to search results.</p>
5245
+ * @public
5246
+ */
5247
+ SearchFilter?: TestCaseSearchFilter | undefined;
5248
+ /**
5249
+ * <p>The search criteria to be used to return test cases.</p>
5250
+ * @public
5251
+ */
5252
+ SearchCriteria?: TestCaseSearchCriteria | undefined;
5253
+ }
4467
5254
  /**
4468
5255
  * @public
4469
5256
  */
@@ -5239,6 +6026,11 @@ export interface StartTaskContactRequest {
5239
6026
  * @public
5240
6027
  */
5241
6028
  SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
6029
+ /**
6030
+ * <p>List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.</p>
6031
+ * @public
6032
+ */
6033
+ Attachments?: TaskAttachment[] | undefined;
5242
6034
  }
5243
6035
  /**
5244
6036
  * @public