@aws-sdk/client-connect 3.1156.0 → 3.1158.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 (43) hide show
  1. package/README.md +7 -0
  2. package/dist-cjs/index.js +58 -3
  3. package/dist-es/Connect.js +2 -0
  4. package/dist-es/commands/UpdateOutboundEmailContactMessageCommand.js +4 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/enums.js +4 -0
  7. package/dist-es/schemas/schemas_0.js +41 -2
  8. package/dist-types/Connect.d.ts +7 -0
  9. package/dist-types/ConnectClient.d.ts +3 -2
  10. package/dist-types/commands/CreateContactCommand.d.ts +1 -1
  11. package/dist-types/commands/CreateRuleCommand.d.ts +1 -1
  12. package/dist-types/commands/DescribeRuleCommand.d.ts +1 -1
  13. package/dist-types/commands/ListContactReferencesCommand.d.ts +2 -2
  14. package/dist-types/commands/StartEmailContactCommand.d.ts +1 -1
  15. package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +1 -1
  16. package/dist-types/commands/StartTaskContactCommand.d.ts +1 -1
  17. package/dist-types/commands/StartWebRTCContactCommand.d.ts +1 -1
  18. package/dist-types/commands/UpdateContactCommand.d.ts +9 -1
  19. package/dist-types/commands/UpdateOutboundEmailContactMessageCommand.d.ts +99 -0
  20. package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +2 -1
  21. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -1
  22. package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
  23. package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
  24. package/dist-types/commands/UpdateRuleCommand.d.ts +1 -1
  25. package/dist-types/commands/index.d.ts +1 -0
  26. package/dist-types/models/enums.d.ts +12 -0
  27. package/dist-types/models/models_2.d.ts +157 -4
  28. package/dist-types/models/models_3.d.ts +86 -108
  29. package/dist-types/models/models_4.d.ts +119 -4
  30. package/dist-types/schemas/schemas_0.d.ts +6 -0
  31. package/dist-types/ts3.4/Connect.d.ts +17 -0
  32. package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
  33. package/dist-types/ts3.4/commands/UpdateOutboundEmailContactMessageCommand.d.ts +42 -0
  34. package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +2 -4
  35. package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +1 -1
  36. package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
  37. package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
  38. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  39. package/dist-types/ts3.4/models/enums.d.ts +6 -0
  40. package/dist-types/ts3.4/models/models_3.d.ts +20 -25
  41. package/dist-types/ts3.4/models/models_4.d.ts +27 -0
  42. package/dist-types/ts3.4/schemas/schemas_0.d.ts +6 -0
  43. package/package.json +5 -5
@@ -0,0 +1,99 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { UpdateOutboundEmailContactMessageRequest, UpdateOutboundEmailContactMessageResponse } from "../models/models_3";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link UpdateOutboundEmailContactMessageCommand}.
11
+ */
12
+ export interface UpdateOutboundEmailContactMessageCommandInput extends UpdateOutboundEmailContactMessageRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link UpdateOutboundEmailContactMessageCommand}.
18
+ */
19
+ export interface UpdateOutboundEmailContactMessageCommandOutput extends UpdateOutboundEmailContactMessageResponse, __MetadataBearer {
20
+ }
21
+ declare const UpdateOutboundEmailContactMessageCommand_base: {
22
+ new (input: UpdateOutboundEmailContactMessageCommandInput): import("@smithy/core/client").CommandImpl<UpdateOutboundEmailContactMessageCommandInput, UpdateOutboundEmailContactMessageCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: UpdateOutboundEmailContactMessageCommandInput): import("@smithy/core/client").CommandImpl<UpdateOutboundEmailContactMessageCommandInput, UpdateOutboundEmailContactMessageCommandOutput, import("..").ConnectClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Updates the draft outbound email message for a contact. Use this operation to save changes to an in-progress
28
+ * outbound email reply before you send it. This operation applies only to contacts with an <code>OUTBOUND</code> or
29
+ * <code>AGENT_REPLY</code> initiation method; it isn't supported for flow-initiated emails.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { ConnectClient, UpdateOutboundEmailContactMessageCommand } from "@aws-sdk/client-connect"; // ES Modules import
34
+ * // const { ConnectClient, UpdateOutboundEmailContactMessageCommand } = require("@aws-sdk/client-connect"); // CommonJS import
35
+ * // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
36
+ * const config = {}; // type is ConnectClientConfig
37
+ * const client = new ConnectClient(config);
38
+ * const input = { // UpdateOutboundEmailContactMessageRequest
39
+ * InstanceId: "STRING_VALUE", // required
40
+ * ContactId: "STRING_VALUE", // required
41
+ * EmailMessage: { // UpdateOutboundEmailContent
42
+ * MessageSourceType: "RAW", // required
43
+ * RawMessage: { // UpdateOutboundRawMessage
44
+ * Body: "STRING_VALUE", // required
45
+ * ContentType: "STRING_VALUE", // required
46
+ * },
47
+ * },
48
+ * };
49
+ * const command = new UpdateOutboundEmailContactMessageCommand(input);
50
+ * const response = await client.send(command);
51
+ * // { // UpdateOutboundEmailContactMessageResponse
52
+ * // ContactId: "STRING_VALUE", // required
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param UpdateOutboundEmailContactMessageCommandInput - {@link UpdateOutboundEmailContactMessageCommandInput}
58
+ * @returns {@link UpdateOutboundEmailContactMessageCommandOutput}
59
+ * @see {@link UpdateOutboundEmailContactMessageCommandInput} for command's `input` shape.
60
+ * @see {@link UpdateOutboundEmailContactMessageCommandOutput} for command's `response` shape.
61
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
62
+ *
63
+ * @throws {@link AccessDeniedException} (client fault)
64
+ * <p>You do not have sufficient permissions to perform this action.</p>
65
+ *
66
+ * @throws {@link InternalServiceException} (server fault)
67
+ * <p>Request processing failed because of an error or failure with the service.</p>
68
+ *
69
+ * @throws {@link InvalidRequestException} (client fault)
70
+ * <p>The request is not valid.</p>
71
+ *
72
+ * @throws {@link ResourceConflictException} (client fault)
73
+ * <p>A resource already has that name.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>The specified resource was not found.</p>
77
+ *
78
+ * @throws {@link ThrottlingException} (client fault)
79
+ * <p>The throttling limit has been exceeded.</p>
80
+ *
81
+ * @throws {@link ConnectServiceException}
82
+ * <p>Base exception class for all service exceptions from Connect service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class UpdateOutboundEmailContactMessageCommand extends UpdateOutboundEmailContactMessageCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: UpdateOutboundEmailContactMessageRequest;
92
+ output: UpdateOutboundEmailContactMessageResponse;
93
+ };
94
+ sdk: {
95
+ input: UpdateOutboundEmailContactMessageCommandInput;
96
+ output: UpdateOutboundEmailContactMessageCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -1,5 +1,6 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { UpdateParticipantRoleConfigRequest, UpdateParticipantRoleConfigResponse } from "../models/models_3";
2
+ import type { UpdateParticipantRoleConfigRequest } from "../models/models_3";
3
+ import type { UpdateParticipantRoleConfigResponse } from "../models/models_4";
3
4
  /**
4
5
  * @public
5
6
  */
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { UpdatePhoneNumberRequest, UpdatePhoneNumberResponse } from "../models/models_3";
2
+ import type { UpdatePhoneNumberRequest, UpdatePhoneNumberResponse } from "../models/models_4";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { UpdatePhoneNumberMetadataRequest } from "../models/models_3";
2
+ import type { UpdatePhoneNumberMetadataRequest } from "../models/models_4";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { UpdatePredefinedAttributeRequest } from "../models/models_3";
2
+ import type { UpdatePredefinedAttributeRequest } from "../models/models_4";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -51,7 +51,7 @@ declare const UpdateRuleCommand_base: {
51
51
  * "<keys>": { // Reference
52
52
  * Value: "STRING_VALUE",
53
53
  * Type: "URL" || "ATTACHMENT" || "CONTACT_ANALYSIS" || "NUMBER" || "STRING" || "DATE" || "EMAIL" || "EMAIL_MESSAGE" || "EMAIL_MESSAGE_PLAIN_TEXT" || "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED" || "EMAIL_MESSAGE_REDACTED", // required
54
- * Status: "AVAILABLE" || "DELETED" || "APPROVED" || "REJECTED" || "PROCESSING" || "FAILED",
54
+ * Status: "AVAILABLE" || "DELETED" || "APPROVED" || "REJECTED" || "PROCESSING" || "FAILED" || "DRAFTING",
55
55
  * Arn: "STRING_VALUE",
56
56
  * StatusReason: "STRING_VALUE",
57
57
  * },
@@ -361,6 +361,7 @@ export * from "./UpdateInstanceStorageConfigCommand";
361
361
  export * from "./UpdateMetricContentCommand";
362
362
  export * from "./UpdateMetricMetadataCommand";
363
363
  export * from "./UpdateNotificationContentCommand";
364
+ export * from "./UpdateOutboundEmailContactMessageCommand";
364
365
  export * from "./UpdateParticipantAuthenticationCommand";
365
366
  export * from "./UpdateParticipantRoleConfigCommand";
366
367
  export * from "./UpdatePhoneNumberCommand";
@@ -510,6 +510,7 @@ export declare const ReferenceStatus: {
510
510
  readonly APPROVED: "APPROVED";
511
511
  readonly AVAILABLE: "AVAILABLE";
512
512
  readonly DELETED: "DELETED";
513
+ readonly DRAFTING: "DRAFTING";
513
514
  readonly FAILED: "FAILED";
514
515
  readonly PROCESSING: "PROCESSING";
515
516
  readonly REJECTED: "REJECTED";
@@ -3067,6 +3068,17 @@ export declare const MeetingFeatureStatus: {
3067
3068
  * @public
3068
3069
  */
3069
3070
  export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
3071
+ /**
3072
+ * @public
3073
+ * @enum
3074
+ */
3075
+ export declare const UpdateOutboundEmailMessageSourceType: {
3076
+ readonly RAW: "RAW";
3077
+ };
3078
+ /**
3079
+ * @public
3080
+ */
3081
+ export type UpdateOutboundEmailMessageSourceType = (typeof UpdateOutboundEmailMessageSourceType)[keyof typeof UpdateOutboundEmailMessageSourceType];
3070
3082
  /**
3071
3083
  * @public
3072
3084
  * @enum
@@ -2162,8 +2162,9 @@ export interface GetMetricDataV2Request {
2162
2162
  * <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FORM_VERSION</code> |
2163
2163
  * <code>INITIATING_FLOW</code> | <code>INITIATION_METHOD</code> |
2164
2164
  * <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
2165
- * <code>KNOWLEDGE_BASE_NAME</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
2166
- * <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> |
2165
+ * <code>KNOWLEDGE_BASE_NAME</code> | <code>LIFETIME_VALUE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
2166
+ * <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> | <code>REPEAT_CALLER</code> |
2167
+ * <code>RESOURCE_PUBLISHED_TIMESTAMP</code> |
2167
2168
  * <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> | <code>SESSION_ID</code> |
2168
2169
  * <code>TEST_CASE</code> | <code>TEST_CASE_EXECUTION_FAILURE_REASON</code> |
2169
2170
  * <code>TEST_CASE_EXECUTION_RESULT</code> | <code>TEST_CASE_EXECUTION_STATE</code> |
@@ -2233,7 +2234,29 @@ export interface GetMetricDataV2Request {
2233
2234
  * <p>To filter by phone number, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html">Create a historical metrics report</a> in
2234
2235
  * the <i>Connect Customer Administrator Guide</i>.</p>
2235
2236
  * </li>
2237
+ * <li>
2238
+ * <p>
2239
+ * <code>LIFETIME_VALUE</code> filters and groups by customer lifetime value segment (High lifetime value,
2240
+ * Medium lifetime value, Low lifetime value). For more information about the calculated attributes that drive these
2241
+ * segments, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customerprofiles-default-calculated-attributes.html">Default calculated
2242
+ * attributes</a> in the <i>Connect Customer Administrator Guide</i>.</p>
2243
+ * </li>
2244
+ * <li>
2245
+ * <p>
2246
+ * <code>REPEAT_CALLER</code> filters and groups by repeat caller status.</p>
2247
+ * </li>
2248
+ * <li>
2249
+ * <p>The <code>LIFETIME_VALUE</code> and <code>REPEAT_CALLER</code> filters and groupings use customer segment
2250
+ * data from Customer Profiles. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/customerprofiles-default-segments.html">Default segments</a> in the
2251
+ * <i>Connect Customer Administrator Guide</i>.</p>
2252
+ * </li>
2236
2253
  * </ul>
2254
+ * <note>
2255
+ * <p>To use the <code>LIFETIME_VALUE</code> and <code>REPEAT_CALLER</code> filters and groupings, users must have
2256
+ * the <b>Customer segments - View</b> permission enabled in their security profile. For
2257
+ * more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html#customerprofiles-permissions-list">List
2258
+ * of security profile permissions</a> in the <i>Connect Customer Administrator Guide</i>.</p>
2259
+ * </note>
2237
2260
  * @public
2238
2261
  */
2239
2262
  Filters: FilterV2[] | undefined;
@@ -2261,9 +2284,9 @@ export interface GetMetricDataV2Request {
2261
2284
  * <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> |
2262
2285
  * <code>FLOWS_OUTCOME_TYPE</code> | <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> |
2263
2286
  * <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
2264
- * <code>KNOWLEDGE_ARTICLE_NAME</code> | <code>KNOWLEDGE_BASE_NAME</code> |
2287
+ * <code>KNOWLEDGE_ARTICLE_NAME</code> | <code>KNOWLEDGE_BASE_NAME</code> | <code>LIFETIME_VALUE</code> |
2265
2288
  * <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> |
2266
- * <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> |
2289
+ * <code>REPEAT_CALLER</code> | <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> | <code>ROUTING_STEP_EXPRESSION</code> |
2267
2290
  * <code>SESSION_ID</code> | <code>TEST_CASE</code> | <code>TEST_CASE_EXECUTION_FAILURE_REASON</code> |
2268
2291
  * <code>TEST_CASE_INVOCATION_METHOD</code> | <code>WEB_NOTIFICATION_TYPE</code>
2269
2292
  * </p>
@@ -3345,6 +3368,136 @@ export interface GetMetricDataV2Request {
3345
3368
  * Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </p>
3346
3369
  * </note>
3347
3370
  * </dd>
3371
+ * <dt>EVALUATED_CHURN_PROPENSITY_RATE</dt>
3372
+ * <dd>
3373
+ * <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
3374
+ * form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
3375
+ * <p>Unit: Percent</p>
3376
+ * <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
3377
+ * Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
3378
+ * Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
3379
+ * Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
3380
+ * Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
3381
+ * Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
3382
+ * Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
3383
+ * Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
3384
+ * Session ID, Subtype, Telephone Number</p>
3385
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-churn-propensity-rate">Evaluated churn propensity rate</a>
3386
+ * </p>
3387
+ * <note>
3388
+ * <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
3389
+ * Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
3390
+ * groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
3391
+ * not valid filters.</p>
3392
+ * <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
3393
+ * the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
3394
+ * request.</p>
3395
+ * </note>
3396
+ * </dd>
3397
+ * <dt>EVALUATED_CSAT_PERCENT</dt>
3398
+ * <dd>
3399
+ * <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
3400
+ * form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
3401
+ * <p>Unit: Percent</p>
3402
+ * <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
3403
+ * Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
3404
+ * Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
3405
+ * Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
3406
+ * Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
3407
+ * Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
3408
+ * Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
3409
+ * Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
3410
+ * Session ID, Subtype, Telephone Number</p>
3411
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-csat-percent">Evaluated CSAT percent</a>
3412
+ * </p>
3413
+ * <note>
3414
+ * <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
3415
+ * Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
3416
+ * groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
3417
+ * not valid filters.</p>
3418
+ * <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
3419
+ * the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
3420
+ * request.</p>
3421
+ * </note>
3422
+ * </dd>
3423
+ * <dt>EVALUATED_PARTIAL_SELF_SERVICE_SUCCESS_RATE</dt>
3424
+ * <dd>
3425
+ * <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
3426
+ * form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
3427
+ * <p>Unit: Percent</p>
3428
+ * <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
3429
+ * Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
3430
+ * Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
3431
+ * Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
3432
+ * Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
3433
+ * Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
3434
+ * Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
3435
+ * Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
3436
+ * Session ID, Subtype, Telephone Number</p>
3437
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-partial-self-service-resolution-rate">Evaluated partial self-service resolution rate</a>
3438
+ * </p>
3439
+ * <note>
3440
+ * <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
3441
+ * Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
3442
+ * groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
3443
+ * not valid filters.</p>
3444
+ * <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
3445
+ * the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
3446
+ * request.</p>
3447
+ * </note>
3448
+ * </dd>
3449
+ * <dt>EVALUATED_SELF_SERVICE_SUCCESS_RATE</dt>
3450
+ * <dd>
3451
+ * <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
3452
+ * form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
3453
+ * <p>Unit: Percent</p>
3454
+ * <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
3455
+ * Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
3456
+ * Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
3457
+ * Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
3458
+ * Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
3459
+ * Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
3460
+ * Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
3461
+ * Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
3462
+ * Session ID, Subtype, Telephone Number</p>
3463
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-self-service-resolution-rate">Evaluated self-service resolution rate</a>
3464
+ * </p>
3465
+ * <note>
3466
+ * <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
3467
+ * Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
3468
+ * groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
3469
+ * not valid filters.</p>
3470
+ * <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
3471
+ * the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
3472
+ * request.</p>
3473
+ * </note>
3474
+ * </dd>
3475
+ * <dt>EVALUATED_SUCCESSFUL_SALE_RATE</dt>
3476
+ * <dd>
3477
+ * <p>This metric requires an evaluation form with business outcome questions. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-evaluation-forms.html">Create an evaluation
3478
+ * form</a> in the <i>Connect Customer Administrator Guide</i>.</p>
3479
+ * <p>Unit: Percent</p>
3480
+ * <p>Valid groupings and filters: Agent, Agent Hierarchy Level One, Agent Hierarchy Level Two, Agent
3481
+ * Hierarchy Level Three, Agent Hierarchy Level Four, Agent Hierarchy Level Five, AI Agent ID, AI Agent Name, AI Agent
3482
+ * Name Version, AI Agent Type, AI Use Case, Bot ID, Bot Intent Name, Bot Locale, Campaign, Campaign Delivery Event
3483
+ * Type, Channel, Contact Category, Disconnect Reason, Email Address, Evaluation Form, Evaluation Question, Evaluation
3484
+ * Section, Evaluation Source, Evaluator, Feature, Flow Type, Flows Module Resource ID, Flows Next Resource ID, Flows
3485
+ * Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type, Flows Resource Alias, Flows Resource ID,
3486
+ * Flows Resource Type, Flows Resource Version, Initiation Method, <b>Lifetime Value</b>,
3487
+ * Proficiency, Q Connect Enabled, Queue, Queue Agent Group Name, Queue Agent Group Type, Queue Type, <b>Repeat Caller</b>, Resource Published Timestamp, Routing Profile, Routing Step Expression,
3488
+ * Session ID, Subtype, Telephone Number</p>
3489
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluated-successful-sale-rate">Evaluated successful sale rate</a>
3490
+ * </p>
3491
+ * <note>
3492
+ * <p>Feature, Flows Next Resource ID, Flows Next Resource Queue ID, Flows Next Resource Type, Flows Outcome Type,
3493
+ * Flows Resource Type, Proficiency, Resource Published Timestamp, and Session ID are valid filters but not valid
3494
+ * groupings. AI Agent Name Version, Campaign Delivery Event Type, and Queue Agent Group Name are valid groupings but
3495
+ * not valid filters.</p>
3496
+ * <p>When requesting business outcome metrics, the filters and groupings used in a single request must belong to
3497
+ * the same metric scope. Filters and groupings from different metric scopes cannot be combined in one
3498
+ * request.</p>
3499
+ * </note>
3500
+ * </dd>
3348
3501
  * <dt>EVALUATIONS_PERFORMED</dt>
3349
3502
  * <dd>
3350
3503
  * <p>Unit: Count</p>
@@ -1,5 +1,5 @@
1
- import type { AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, AutoEvaluationStatus, Behavior, BooleanComparisonType, Channel, ChatEventType, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, EmailHeaderType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MediaType, MeetingFeatureStatus, MetricUnit, MonitorCapability, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SecurityProfileType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TestCaseExecutionStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
2
- import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentHierarchyGroups, AgentStatus, AiAgentInput, AiAgentsCriteria, AliasConfiguration, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MetricCalculation, OutboundStrategy, PredefinedAttributeValues, PreEvaluationFilters, PrimaryValue, RecurrenceConfig, Reference, RuleTriggerEventSource, StringCondition, TagCondition, Validation } from "./models_0";
1
+ import type { AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, AutoEvaluationStatus, Behavior, BooleanComparisonType, Channel, ChatEventType, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, EmailHeaderType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MediaType, MeetingFeatureStatus, MetricUnit, MonitorCapability, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SecurityProfileType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TestCaseExecutionStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, UpdateOutboundEmailMessageSourceType, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
2
+ import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentHierarchyGroups, AgentStatus, AiAgentInput, AiAgentsCriteria, AliasConfiguration, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, MetricCalculation, OutboundStrategy, PreEvaluationFilters, PrimaryValue, RecurrenceConfig, Reference, RuleTriggerEventSource, StringCondition, TagCondition, Validation } from "./models_0";
3
3
  import type { AutoAcceptConfig, ContactFlow, ContactFlowModule, DataTable, EvaluationAnswerData, EvaluationNote, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, MetricDefinition, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, UserPhoneConfig, View, VoiceEnhancementConfig } from "./models_1";
4
4
  /**
5
5
  * @public
@@ -5536,6 +5536,18 @@ export interface UpdateAuthenticationProfileRequest {
5536
5536
  */
5537
5537
  SessionInactivityHandlingEnabled?: boolean | undefined;
5538
5538
  }
5539
+ /**
5540
+ * Additional recipients for UpdateContact, allowing an empty list to clear CC recipients.
5541
+ * @public
5542
+ */
5543
+ export interface NullableAdditionalRecipients {
5544
+ /**
5545
+ * <p>The additional CC email address recipients. You can specify up to 50 addresses. Provide an empty list to clear
5546
+ * the existing CC recipients.</p>
5547
+ * @public
5548
+ */
5549
+ CcEmailAddresses?: EmailAddressInfo[] | undefined;
5550
+ }
5539
5551
  /**
5540
5552
  * <p>Information about a queue.</p>
5541
5553
  * @public
@@ -6494,6 +6506,78 @@ export interface UpdateNotificationContentRequest {
6494
6506
  */
6495
6507
  export interface UpdateNotificationContentResponse {
6496
6508
  }
6509
+ /**
6510
+ * <p>Contains the raw body content of an outbound email draft.</p>
6511
+ * @public
6512
+ */
6513
+ export interface UpdateOutboundRawMessage {
6514
+ /**
6515
+ * <p>The email message body.</p>
6516
+ * @public
6517
+ */
6518
+ Body: string | undefined;
6519
+ /**
6520
+ * <p>The content type of the email body. Valid values:</p>
6521
+ * <ul>
6522
+ * <li>
6523
+ * <p>
6524
+ * <code>text/plain</code> – Plain text content.</p>
6525
+ * </li>
6526
+ * <li>
6527
+ * <p>
6528
+ * <code>text/html</code> – HTML-formatted content.</p>
6529
+ * </li>
6530
+ * </ul>
6531
+ * @public
6532
+ */
6533
+ ContentType: string | undefined;
6534
+ }
6535
+ /**
6536
+ * <p>Contains the updated body content for an outbound email draft.</p>
6537
+ * @public
6538
+ */
6539
+ export interface UpdateOutboundEmailContent {
6540
+ /**
6541
+ * <p>The message source type. The only supported value is <code>RAW</code>.</p>
6542
+ * @public
6543
+ */
6544
+ MessageSourceType: UpdateOutboundEmailMessageSourceType | undefined;
6545
+ /**
6546
+ * <p>The raw email body content.</p>
6547
+ * @public
6548
+ */
6549
+ RawMessage: UpdateOutboundRawMessage | undefined;
6550
+ }
6551
+ /**
6552
+ * @public
6553
+ */
6554
+ export interface UpdateOutboundEmailContactMessageRequest {
6555
+ /**
6556
+ * <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>
6557
+ * @public
6558
+ */
6559
+ InstanceId: string | undefined;
6560
+ /**
6561
+ * <p>The identifier of the contact in this instance of Connect Customer. </p>
6562
+ * @public
6563
+ */
6564
+ ContactId: string | undefined;
6565
+ /**
6566
+ * <p>The email message body to update on the outbound email draft.</p>
6567
+ * @public
6568
+ */
6569
+ EmailMessage: UpdateOutboundEmailContent | undefined;
6570
+ }
6571
+ /**
6572
+ * @public
6573
+ */
6574
+ export interface UpdateOutboundEmailContactMessageResponse {
6575
+ /**
6576
+ * <p>The identifier of the contact in this instance of Connect Customer. </p>
6577
+ * @public
6578
+ */
6579
+ ContactId: string | undefined;
6580
+ }
6497
6581
  /**
6498
6582
  * @public
6499
6583
  */
@@ -6671,109 +6755,3 @@ export interface UpdateParticipantRoleConfigRequest {
6671
6755
  */
6672
6756
  ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
6673
6757
  }
6674
- /**
6675
- * @public
6676
- */
6677
- export interface UpdateParticipantRoleConfigResponse {
6678
- }
6679
- /**
6680
- * @public
6681
- */
6682
- export interface UpdatePhoneNumberRequest {
6683
- /**
6684
- * <p>A unique identifier for the phone number.</p>
6685
- * @public
6686
- */
6687
- PhoneNumberId: string | undefined;
6688
- /**
6689
- * <p>The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
6690
- * @public
6691
- */
6692
- TargetArn?: string | undefined;
6693
- /**
6694
- * <p>The identifier of the Connect Customer instance that phone numbers are claimed to. You
6695
- * can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
6696
- * instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
6697
- * @public
6698
- */
6699
- InstanceId?: string | undefined;
6700
- /**
6701
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6702
- * request. If not provided, the Amazon Web Services
6703
- * SDK populates this field. For more information about idempotency, see
6704
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6705
- * @public
6706
- */
6707
- ClientToken?: string | undefined;
6708
- }
6709
- /**
6710
- * @public
6711
- */
6712
- export interface UpdatePhoneNumberResponse {
6713
- /**
6714
- * <p>A unique identifier for the phone number.</p>
6715
- * @public
6716
- */
6717
- PhoneNumberId?: string | undefined;
6718
- /**
6719
- * <p>The Amazon Resource Name (ARN) of the phone number.</p>
6720
- * @public
6721
- */
6722
- PhoneNumberArn?: string | undefined;
6723
- }
6724
- /**
6725
- * @public
6726
- */
6727
- export interface UpdatePhoneNumberMetadataRequest {
6728
- /**
6729
- * <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
6730
- * @public
6731
- */
6732
- PhoneNumberId: string | undefined;
6733
- /**
6734
- * <p>The description of the phone number.</p>
6735
- * @public
6736
- */
6737
- PhoneNumberDescription?: string | undefined;
6738
- /**
6739
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6740
- * request. If not provided, the Amazon Web Services
6741
- * SDK populates this field. For more information about idempotency, see
6742
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6743
- * @public
6744
- */
6745
- ClientToken?: string | undefined;
6746
- }
6747
- /**
6748
- * @public
6749
- */
6750
- export interface UpdatePredefinedAttributeRequest {
6751
- /**
6752
- * <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the
6753
- * instance.</p>
6754
- * @public
6755
- */
6756
- InstanceId: string | undefined;
6757
- /**
6758
- * <p>The name of the predefined attribute.</p>
6759
- * @public
6760
- */
6761
- Name: string | undefined;
6762
- /**
6763
- * <p>The values of the predefined attribute.</p>
6764
- * @public
6765
- */
6766
- Values?: PredefinedAttributeValues | undefined;
6767
- /**
6768
- * <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.</p>
6769
- * @public
6770
- */
6771
- Purposes?: string[] | undefined;
6772
- /**
6773
- * <p>Custom metadata that is associated to predefined attributes to control behavior
6774
- * in upstream services, such as controlling
6775
- * how a predefined attribute should be displayed in the Connect Customer admin website.</p>
6776
- * @public
6777
- */
6778
- AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined;
6779
- }