Skip to content

Commit 45c43b4

Browse files
author
awstools
committed
feat(client-connect): Added support for Conditional Questions in Evaluation Forms. Introduced Auto Evaluation capability for Evaluation Forms and Contact Evaluations. Added new API operations: SearchEvaluationForms and SearchContactEvaluations.
1 parent e38ba81 commit 45c43b4

File tree

54 files changed

+11807
-6988
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+11807
-6988
lines changed

‎clients/client-connect/README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1793,6 +1793,14 @@ SearchAvailablePhoneNumbers
17931793

17941794
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchAvailablePhoneNumbersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchAvailablePhoneNumbersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchAvailablePhoneNumbersCommandOutput/)
17951795

1796+
</details>
1797+
<details>
1798+
<summary>
1799+
SearchContactEvaluations
1800+
</summary>
1801+
1802+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchContactEvaluationsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchContactEvaluationsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchContactEvaluationsCommandOutput/)
1803+
17961804
</details>
17971805
<details>
17981806
<summary>
@@ -1825,6 +1833,14 @@ SearchEmailAddresses
18251833

18261834
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchEmailAddressesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchEmailAddressesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchEmailAddressesCommandOutput/)
18271835

1836+
</details>
1837+
<details>
1838+
<summary>
1839+
SearchEvaluationForms
1840+
</summary>
1841+
1842+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/SearchEvaluationFormsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchEvaluationFormsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/SearchEvaluationFormsCommandOutput/)
1843+
18281844
</details>
18291845
<details>
18301846
<summary>

‎clients/client-connect/src/Connect.ts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -922,6 +922,11 @@ import {
922922
SearchAvailablePhoneNumbersCommandInput,
923923
SearchAvailablePhoneNumbersCommandOutput,
924924
} from "./commands/SearchAvailablePhoneNumbersCommand";
925+
import {
926+
SearchContactEvaluationsCommand,
927+
SearchContactEvaluationsCommandInput,
928+
SearchContactEvaluationsCommandOutput,
929+
} from "./commands/SearchContactEvaluationsCommand";
925930
import {
926931
SearchContactFlowModulesCommand,
927932
SearchContactFlowModulesCommandInput,
@@ -942,6 +947,11 @@ import {
942947
SearchEmailAddressesCommandInput,
943948
SearchEmailAddressesCommandOutput,
944949
} from "./commands/SearchEmailAddressesCommand";
950+
import {
951+
SearchEvaluationFormsCommand,
952+
SearchEvaluationFormsCommandInput,
953+
SearchEvaluationFormsCommandOutput,
954+
} from "./commands/SearchEvaluationFormsCommand";
945955
import {
946956
SearchHoursOfOperationOverridesCommand,
947957
SearchHoursOfOperationOverridesCommandInput,
@@ -1556,10 +1566,12 @@ const commands = {
15561566
ResumeContactRecordingCommand,
15571567
SearchAgentStatusesCommand,
15581568
SearchAvailablePhoneNumbersCommand,
1569+
SearchContactEvaluationsCommand,
15591570
SearchContactFlowModulesCommand,
15601571
SearchContactFlowsCommand,
15611572
SearchContactsCommand,
15621573
SearchEmailAddressesCommand,
1574+
SearchEvaluationFormsCommand,
15631575
SearchHoursOfOperationOverridesCommand,
15641576
SearchHoursOfOperationsCommand,
15651577
SearchPredefinedAttributesCommand,
@@ -4754,6 +4766,23 @@ export interface Connect {
47544766
cb: (err: any, data?: SearchAvailablePhoneNumbersCommandOutput) => void
47554767
): void;
47564768

4769+
/**
4770+
* @see {@link SearchContactEvaluationsCommand}
4771+
*/
4772+
searchContactEvaluations(
4773+
args: SearchContactEvaluationsCommandInput,
4774+
options?: __HttpHandlerOptions
4775+
): Promise<SearchContactEvaluationsCommandOutput>;
4776+
searchContactEvaluations(
4777+
args: SearchContactEvaluationsCommandInput,
4778+
cb: (err: any, data?: SearchContactEvaluationsCommandOutput) => void
4779+
): void;
4780+
searchContactEvaluations(
4781+
args: SearchContactEvaluationsCommandInput,
4782+
options: __HttpHandlerOptions,
4783+
cb: (err: any, data?: SearchContactEvaluationsCommandOutput) => void
4784+
): void;
4785+
47574786
/**
47584787
* @see {@link SearchContactFlowModulesCommand}
47594788
*/
@@ -4819,6 +4848,23 @@ export interface Connect {
48194848
cb: (err: any, data?: SearchEmailAddressesCommandOutput) => void
48204849
): void;
48214850

4851+
/**
4852+
* @see {@link SearchEvaluationFormsCommand}
4853+
*/
4854+
searchEvaluationForms(
4855+
args: SearchEvaluationFormsCommandInput,
4856+
options?: __HttpHandlerOptions
4857+
): Promise<SearchEvaluationFormsCommandOutput>;
4858+
searchEvaluationForms(
4859+
args: SearchEvaluationFormsCommandInput,
4860+
cb: (err: any, data?: SearchEvaluationFormsCommandOutput) => void
4861+
): void;
4862+
searchEvaluationForms(
4863+
args: SearchEvaluationFormsCommandInput,
4864+
options: __HttpHandlerOptions,
4865+
cb: (err: any, data?: SearchEvaluationFormsCommandOutput) => void
4866+
): void;
4867+
48224868
/**
48234869
* @see {@link SearchHoursOfOperationOverridesCommand}
48244870
*/

‎clients/client-connect/src/ConnectClient.ts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,10 @@ import {
597597
SearchAvailablePhoneNumbersCommandInput,
598598
SearchAvailablePhoneNumbersCommandOutput,
599599
} from "./commands/SearchAvailablePhoneNumbersCommand";
600+
import {
601+
SearchContactEvaluationsCommandInput,
602+
SearchContactEvaluationsCommandOutput,
603+
} from "./commands/SearchContactEvaluationsCommand";
600604
import {
601605
SearchContactFlowModulesCommandInput,
602606
SearchContactFlowModulesCommandOutput,
@@ -607,6 +611,10 @@ import {
607611
SearchEmailAddressesCommandInput,
608612
SearchEmailAddressesCommandOutput,
609613
} from "./commands/SearchEmailAddressesCommand";
614+
import {
615+
SearchEvaluationFormsCommandInput,
616+
SearchEvaluationFormsCommandOutput,
617+
} from "./commands/SearchEvaluationFormsCommand";
610618
import {
611619
SearchHoursOfOperationOverridesCommandInput,
612620
SearchHoursOfOperationOverridesCommandOutput,
@@ -1085,10 +1093,12 @@ export type ServiceInputTypes =
10851093
| ResumeContactRecordingCommandInput
10861094
| SearchAgentStatusesCommandInput
10871095
| SearchAvailablePhoneNumbersCommandInput
1096+
| SearchContactEvaluationsCommandInput
10881097
| SearchContactFlowModulesCommandInput
10891098
| SearchContactFlowsCommandInput
10901099
| SearchContactsCommandInput
10911100
| SearchEmailAddressesCommandInput
1101+
| SearchEvaluationFormsCommandInput
10921102
| SearchHoursOfOperationOverridesCommandInput
10931103
| SearchHoursOfOperationsCommandInput
10941104
| SearchPredefinedAttributesCommandInput
@@ -1377,10 +1387,12 @@ export type ServiceOutputTypes =
13771387
| ResumeContactRecordingCommandOutput
13781388
| SearchAgentStatusesCommandOutput
13791389
| SearchAvailablePhoneNumbersCommandOutput
1390+
| SearchContactEvaluationsCommandOutput
13801391
| SearchContactFlowModulesCommandOutput
13811392
| SearchContactFlowsCommandOutput
13821393
| SearchContactsCommandOutput
13831394
| SearchEmailAddressesCommandOutput
1395+
| SearchEvaluationFormsCommandOutput
13841396
| SearchHoursOfOperationOverridesCommandOutput
13851397
| SearchHoursOfOperationsCommandOutput
13861398
| SearchPredefinedAttributesCommandOutput

‎clients/client-connect/src/commands/CreateEvaluationFormCommand.ts‎

Lines changed: 96 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,17 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
7676
* MaxValue: Number("int"), // required
7777
* Score: Number("int"),
7878
* AutomaticFail: true || false,
79+
* AutomaticFailConfiguration: { // AutomaticFailConfiguration
80+
* TargetSection: "STRING_VALUE",
81+
* },
7982
* },
8083
* ],
8184
* Automation: { // EvaluationFormNumericQuestionAutomation Union: only one key present
8285
* PropertyValue: { // NumericQuestionPropertyValueAutomation
83-
* Label: "OVERALL_CUSTOMER_SENTIMENT_SCORE" || "OVERALL_AGENT_SENTIMENT_SCORE" || "NON_TALK_TIME" || "NON_TALK_TIME_PERCENTAGE" || "NUMBER_OF_INTERRUPTIONS" || "CONTACT_DURATION" || "AGENT_INTERACTION_DURATION" || "CUSTOMER_HOLD_TIME", // required
86+
* Label: "OVERALL_CUSTOMER_SENTIMENT_SCORE" || "OVERALL_AGENT_SENTIMENT_SCORE" || "NON_TALK_TIME" || "NON_TALK_TIME_PERCENTAGE" || "NUMBER_OF_INTERRUPTIONS" || "CONTACT_DURATION" || "AGENT_INTERACTION_DURATION" || "CUSTOMER_HOLD_TIME" || "LONGEST_HOLD_DURATION" || "NUMBER_OF_HOLDS" || "AGENT_INTERACTION_AND_HOLD_DURATION", // required
87+
* },
88+
* AnswerSource: { // EvaluationFormQuestionAutomationAnswerSource
89+
* SourceType: "CONTACT_LENS_DATA" || "GEN_AI", // required
8490
* },
8591
* },
8692
* },
@@ -91,11 +97,14 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
9197
* Text: "STRING_VALUE", // required
9298
* Score: Number("int"),
9399
* AutomaticFail: true || false,
100+
* AutomaticFailConfiguration: {
101+
* TargetSection: "STRING_VALUE",
102+
* },
94103
* },
95104
* ],
96105
* DisplayAs: "DROPDOWN" || "RADIO",
97106
* Automation: { // EvaluationFormSingleSelectQuestionAutomation
98-
* Options: [ // EvaluationFormSingleSelectQuestionAutomationOptionList // required
107+
* Options: [ // EvaluationFormSingleSelectQuestionAutomationOptionList
99108
* { // EvaluationFormSingleSelectQuestionAutomationOption Union: only one key present
100109
* RuleCategory: { // SingleSelectQuestionRuleCategoryAutomation
101110
* Category: "STRING_VALUE", // required
@@ -105,9 +114,64 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
105114
* },
106115
* ],
107116
* DefaultOptionRefId: "STRING_VALUE",
117+
* AnswerSource: {
118+
* SourceType: "CONTACT_LENS_DATA" || "GEN_AI", // required
119+
* },
120+
* },
121+
* },
122+
* Text: { // EvaluationFormTextQuestionProperties
123+
* Automation: { // EvaluationFormTextQuestionAutomation
124+
* AnswerSource: {
125+
* SourceType: "CONTACT_LENS_DATA" || "GEN_AI", // required
126+
* },
108127
* },
109128
* },
110129
* },
130+
* Enablement: { // EvaluationFormItemEnablementConfiguration
131+
* Condition: { // EvaluationFormItemEnablementCondition
132+
* Operands: [ // EvaluationFormItemEnablementConditionOperandList // required
133+
* { // EvaluationFormItemEnablementConditionOperand Union: only one key present
134+
* Expression: { // EvaluationFormItemEnablementExpression
135+
* Source: { // EvaluationFormItemEnablementSource
136+
* Type: "QUESTION_REF_ID", // required
137+
* RefId: "STRING_VALUE",
138+
* },
139+
* Values: [ // EvaluationFormItemEnablementSourceValueList // required
140+
* { // EvaluationFormItemEnablementSourceValue
141+
* Type: "OPTION_REF_ID", // required
142+
* RefId: "STRING_VALUE",
143+
* },
144+
* ],
145+
* Comparator: "IN" || "NOT_IN", // required
146+
* },
147+
* Condition: {
148+
* Operands: [ // required
149+
* {// Union: only one key present
150+
* Expression: {
151+
* Source: {
152+
* Type: "QUESTION_REF_ID", // required
153+
* RefId: "STRING_VALUE",
154+
* },
155+
* Values: [ // required
156+
* {
157+
* Type: "OPTION_REF_ID", // required
158+
* RefId: "STRING_VALUE",
159+
* },
160+
* ],
161+
* Comparator: "IN" || "NOT_IN", // required
162+
* },
163+
* Condition: "<EvaluationFormItemEnablementCondition>",
164+
* },
165+
* ],
166+
* Operator: "OR" || "AND",
167+
* },
168+
* },
169+
* ],
170+
* Operator: "OR" || "AND",
171+
* },
172+
* Action: "DISABLE" || "ENABLE", // required
173+
* DefaultAction: "DISABLE" || "ENABLE",
174+
* },
111175
* Weight: Number("double"),
112176
* },
113177
* },
@@ -130,11 +194,17 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
130194
* MaxValue: Number("int"), // required
131195
* Score: Number("int"),
132196
* AutomaticFail: true || false,
197+
* AutomaticFailConfiguration: {
198+
* TargetSection: "STRING_VALUE",
199+
* },
133200
* },
134201
* ],
135202
* Automation: {// Union: only one key present
136203
* PropertyValue: {
137-
* Label: "OVERALL_CUSTOMER_SENTIMENT_SCORE" || "OVERALL_AGENT_SENTIMENT_SCORE" || "NON_TALK_TIME" || "NON_TALK_TIME_PERCENTAGE" || "NUMBER_OF_INTERRUPTIONS" || "CONTACT_DURATION" || "AGENT_INTERACTION_DURATION" || "CUSTOMER_HOLD_TIME", // required
204+
* Label: "OVERALL_CUSTOMER_SENTIMENT_SCORE" || "OVERALL_AGENT_SENTIMENT_SCORE" || "NON_TALK_TIME" || "NON_TALK_TIME_PERCENTAGE" || "NUMBER_OF_INTERRUPTIONS" || "CONTACT_DURATION" || "AGENT_INTERACTION_DURATION" || "CUSTOMER_HOLD_TIME" || "LONGEST_HOLD_DURATION" || "NUMBER_OF_HOLDS" || "AGENT_INTERACTION_AND_HOLD_DURATION", // required
205+
* },
206+
* AnswerSource: {
207+
* SourceType: "CONTACT_LENS_DATA" || "GEN_AI", // required
138208
* },
139209
* },
140210
* },
@@ -145,11 +215,14 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
145215
* Text: "STRING_VALUE", // required
146216
* Score: Number("int"),
147217
* AutomaticFail: true || false,
218+
* AutomaticFailConfiguration: {
219+
* TargetSection: "STRING_VALUE",
220+
* },
148221
* },
149222
* ],
150223
* DisplayAs: "DROPDOWN" || "RADIO",
151224
* Automation: {
152-
* Options: [ // required
225+
* Options: [
153226
* {// Union: only one key present
154227
* RuleCategory: {
155228
* Category: "STRING_VALUE", // required
@@ -159,9 +232,22 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
159232
* },
160233
* ],
161234
* DefaultOptionRefId: "STRING_VALUE",
235+
* AnswerSource: {
236+
* SourceType: "CONTACT_LENS_DATA" || "GEN_AI", // required
237+
* },
238+
* },
239+
* },
240+
* Text: {
241+
* Automation: {
242+
* AnswerSource: "<EvaluationFormQuestionAutomationAnswerSource>",
162243
* },
163244
* },
164245
* },
246+
* Enablement: {
247+
* Condition: "<EvaluationFormItemEnablementCondition>", // required
248+
* Action: "DISABLE" || "ENABLE", // required
249+
* DefaultAction: "DISABLE" || "ENABLE",
250+
* },
165251
* Weight: Number("double"),
166252
* },
167253
* },
@@ -170,7 +256,13 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
170256
* Mode: "QUESTION_ONLY" || "SECTION_ONLY", // required
171257
* Status: "ENABLED" || "DISABLED", // required
172258
* },
259+
* AutoEvaluationConfiguration: { // EvaluationFormAutoEvaluationConfiguration
260+
* Enabled: true || false, // required
261+
* },
173262
* ClientToken: "STRING_VALUE",
263+
* Tags: { // TagMap
264+
* "<keys>": "STRING_VALUE",
265+
* },
174266
* };
175267
* const command = new CreateEvaluationFormCommand(input);
176268
* const response = await client.send(command);

‎clients/client-connect/src/commands/CreateViewCommand.ts‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import {
10-
CreateViewRequest,
11-
CreateViewRequestFilterSensitiveLog,
12-
CreateViewResponse,
13-
CreateViewResponseFilterSensitiveLog,
14-
} from "../models/models_0";
9+
import { CreateViewRequest, CreateViewRequestFilterSensitiveLog } from "../models/models_0";
10+
import { CreateViewResponse, CreateViewResponseFilterSensitiveLog } from "../models/models_1";
1511
import { de_CreateViewCommand, se_CreateViewCommand } from "../protocols/Aws_restJson1";
1612

1713
/**

‎clients/client-connect/src/commands/CreateViewVersionCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
CreateViewVersionRequest,
1111
CreateViewVersionResponse,
1212
CreateViewVersionResponseFilterSensitiveLog,
13-
} from "../models/models_0";
13+
} from "../models/models_1";
1414
import { de_CreateViewVersionCommand, se_CreateViewVersionCommand } from "../protocols/Aws_restJson1";
1515

1616
/**

‎clients/client-connect/src/commands/CreateVocabularyCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { CreateVocabularyRequest, CreateVocabularyResponse } from "../models/models_0";
9+
import { CreateVocabularyRequest, CreateVocabularyResponse } from "../models/models_1";
1010
import { de_CreateVocabularyCommand, se_CreateVocabularyCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

‎clients/client-connect/src/commands/DeactivateEvaluationFormCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DeactivateEvaluationFormRequest, DeactivateEvaluationFormResponse } from "../models/models_0";
9+
import { DeactivateEvaluationFormRequest, DeactivateEvaluationFormResponse } from "../models/models_1";
1010
import { de_DeactivateEvaluationFormCommand, se_DeactivateEvaluationFormCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

‎clients/client-connect/src/commands/DeleteAttachedFileCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DeleteAttachedFileRequest, DeleteAttachedFileResponse } from "../models/models_0";
9+
import { DeleteAttachedFileRequest, DeleteAttachedFileResponse } from "../models/models_1";
1010
import { de_DeleteAttachedFileCommand, se_DeleteAttachedFileCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

‎clients/client-connect/src/commands/DescribeAuthenticationProfileCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface DescribeAuthenticationProfileCommandOutput
3434

3535
/**
3636
* <p>This API is in preview release for Amazon Connect and is subject to change. To
37-
* request access to this API, contact Amazon Web ServicesSupport.</p>
37+
* request access to this API, contact Amazon Web Services Support.</p>
3838
* <p>Describes the target authentication profile.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)