Skip to content

Commit

Permalink
feat(client-connect): Amazon Connect Evaluation Capabilities: validat…
Browse files Browse the repository at this point in the history 
…ion improvements
  • Loading branch information
awstools committed May 24, 2023
1 parent 7f8d884 commit 60a8a56
Show file tree
Hide file tree
Showing 14 changed files with 65 additions and 45 deletions.
11 changes: 5 additions & 6 deletions clients/client-connect/src/commands/CreateEvaluationFormCommand.ts
View file
Expand Up @@ -37,10 +37,9 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR

/**
* @public
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be
* used to define questions related to agent performance, and create sections to organize such
* questions. Question and section identifiers cannot be duplicated within the same evaluation
* form.</p>
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define
* questions related to agent performance, and create sections to organize such questions. Question and section identifiers
* cannot be duplicated within the same evaluation form.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -57,13 +56,13 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
* Title: "STRING_VALUE", // required
* RefId: "STRING_VALUE", // required
* Instructions: "STRING_VALUE",
* Items: [
* Items: [ // required
* {// Union: only one key present
* Section: {
* Title: "STRING_VALUE", // required
* RefId: "STRING_VALUE", // required
* Instructions: "STRING_VALUE",
* Items: "<EvaluationFormItemsList>",
* Items: "<EvaluationFormItemsList>", // required
* Weight: Number("double"),
* },
* Question: { // EvaluationFormQuestion
Expand Down
2 changes: 1 addition & 1 deletion clients/client-connect/src/commands/CreateParticipantCommand.ts
View file
Expand Up @@ -37,7 +37,7 @@ export interface CreateParticipantCommandOutput extends CreateParticipantRespons
/**
* @public
* <p>Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html">Customize chat
* flow experiences by integrating custom participants</a>.</p>
* flow experiences by integrating custom participants</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
4 changes: 4 additions & 0 deletions clients/client-connect/src/commands/CreatePromptCommand.ts
View file
Expand Up @@ -17,6 +17,10 @@ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } fr
import { CreatePromptRequest, CreatePromptResponse } from "../models/models_0";
import { de_CreatePromptCommand, se_CreatePromptCommand } from "../protocols/Aws_restJson1";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
Expand Down
4 changes: 2 additions & 2 deletions clients/client-connect/src/commands/DeleteEvaluationFormCommand.ts
View file
Expand Up @@ -39,8 +39,8 @@ export interface DeleteEvaluationFormCommandOutput extends __MetadataBearer {}
* <p>Deletes an evaluation form in the specified Amazon Connect instance. </p>
* <ul>
* <li>
* <p>If the version property is provided, only the specified version of the evaluation form is
* deleted.</p>
* <p>If the version
* property is provided, only the specified version of the evaluation form is deleted.</p>
* </li>
* <li>
* <p>If no version is provided, then the full form (all versions) is deleted.</p>
Expand Down
4 changes: 4 additions & 0 deletions clients/client-connect/src/commands/DeletePromptCommand.ts
View file
Expand Up @@ -17,6 +17,10 @@ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } fr
import { DeletePromptRequest } from "../models/models_0";
import { de_DeletePromptCommand, se_DeletePromptCommand } from "../protocols/Aws_restJson1";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
Expand Down
4 changes: 2 additions & 2 deletions clients/client-connect/src/commands/DescribeContactEvaluationCommand.ts
View file
Expand Up @@ -109,13 +109,13 @@ export interface DescribeContactEvaluationCommandOutput extends DescribeContactE
* // Title: "STRING_VALUE", // required
* // RefId: "STRING_VALUE", // required
* // Instructions: "STRING_VALUE",
* // Items: [
* // Items: [ // required
* // {// Union: only one key present
* // Section: {
* // Title: "STRING_VALUE", // required
* // RefId: "STRING_VALUE", // required
* // Instructions: "STRING_VALUE",
* // Items: "<EvaluationFormItemsList>",
* // Items: "<EvaluationFormItemsList>", // required
* // Weight: Number("double"),
* // },
* // Question: { // EvaluationFormQuestion
Expand Down
4 changes: 2 additions & 2 deletions clients/client-connect/src/commands/DescribeEvaluationFormCommand.ts
View file
Expand Up @@ -67,13 +67,13 @@ export interface DescribeEvaluationFormCommandOutput extends DescribeEvaluationF
* // Title: "STRING_VALUE", // required
* // RefId: "STRING_VALUE", // required
* // Instructions: "STRING_VALUE",
* // Items: [
* // Items: [ // required
* // {// Union: only one key present
* // Section: {
* // Title: "STRING_VALUE", // required
* // RefId: "STRING_VALUE", // required
* // Instructions: "STRING_VALUE",
* // Items: "<EvaluationFormItemsList>",
* // Items: "<EvaluationFormItemsList>", // required
* // Weight: Number("double"),
* // },
* // Question: { // EvaluationFormQuestion
Expand Down
4 changes: 4 additions & 0 deletions clients/client-connect/src/commands/DescribePromptCommand.ts
View file
Expand Up @@ -17,6 +17,10 @@ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } fr
import { DescribePromptRequest, DescribePromptResponse } from "../models/models_0";
import { de_DescribePromptCommand, se_DescribePromptCommand } from "../protocols/Aws_restJson1";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
Expand Down
4 changes: 4 additions & 0 deletions clients/client-connect/src/commands/GetPromptFileCommand.ts
View file
Expand Up @@ -17,6 +17,10 @@ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } fr
import { GetPromptFileRequest, GetPromptFileResponse } from "../models/models_1";
import { de_GetPromptFileCommand, se_GetPromptFileCommand } from "../protocols/Aws_restJson1";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
Expand Down
11 changes: 5 additions & 6 deletions clients/client-connect/src/commands/UpdateEvaluationFormCommand.ts
View file
Expand Up @@ -37,10 +37,9 @@ export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormR
/**
* @public
* <p>Updates details about a specific evaluation form version in the specified Amazon Connect
* instance. Question and section identifiers cannot be duplicated within the same evaluation
* form.</p>
* <p>This operation does not support partial updates. Instead it does a full update of evaluation
* form content.</p>
* instance. Question and section
* identifiers cannot be duplicated within the same evaluation form.</p>
* <p>This operation does not support partial updates. Instead it does a full update of evaluation form content.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -60,13 +59,13 @@ export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormR
* Title: "STRING_VALUE", // required
* RefId: "STRING_VALUE", // required
* Instructions: "STRING_VALUE",
* Items: [
* Items: [ // required
* {// Union: only one key present
* Section: {
* Title: "STRING_VALUE", // required
* RefId: "STRING_VALUE", // required
* Instructions: "STRING_VALUE",
* Items: "<EvaluationFormItemsList>",
* Items: "<EvaluationFormItemsList>", // required
* Weight: Number("double"),
* },
* Question: { // EvaluationFormQuestion
Expand Down
4 changes: 4 additions & 0 deletions clients/client-connect/src/commands/UpdatePromptCommand.ts
View file
Expand Up @@ -17,6 +17,10 @@ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } fr
import { UpdatePromptRequest, UpdatePromptResponse } from "../models/models_1";
import { de_UpdatePromptCommand, se_UpdatePromptCommand } from "../protocols/Aws_restJson1";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
Expand Down
16 changes: 8 additions & 8 deletions clients/client-connect/src/models/models_0.ts
View file
Expand Up @@ -67,8 +67,8 @@ export interface ActivateEvaluationFormRequest {
EvaluationFormId: string | undefined;

/**
* <p>The version of the evaluation form to activate. If the version property is not provided, the
* latest version of the evaluation form is activated.</p>
* <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the
* evaluation form is activated.</p>
*/
EvaluationFormVersion: number | undefined;
}
Expand Down Expand Up @@ -1550,10 +1550,10 @@ export interface SingleSelectQuestionRuleCategoryAutomation {
Category: string | undefined;

/**
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,
* then the option is applied when the contact data includes the category. Similarly, if the
* condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not
* include the category.</p>
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>, then the
* option is applied when the contact data includes the category. Similarly, if the condition is
* <code>NOT_PRESENT</code>, then the option is applied when the contact data does not include the
* category.</p>
*/
Condition: SingleSelectQuestionRuleCategoryAutomationCondition | string | undefined;

Expand Down Expand Up @@ -2186,8 +2186,8 @@ export interface ParticipantTokenCredentials {
*/
export interface CreateParticipantResponse {
/**
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
* participant token is valid for the lifetime of a chat participant.</p>
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
* token is valid for the lifetime of a chat participant.</p>
*/
ParticipantCredentials?: ParticipantTokenCredentials;

Expand Down
5 changes: 2 additions & 3 deletions clients/client-connect/src/models/models_1.ts
View file
Expand Up @@ -867,8 +867,7 @@ export interface MetricFilterV2 {
* <p>The key to use for filtering data. </p>
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
* These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
* Guide</i>. </p>
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
*/
MetricFilterKey?: string;

Expand Down Expand Up @@ -6948,7 +6947,7 @@ export interface EvaluationFormSection {
/**
* <p>The items of the section.</p>
*/
Items?: EvaluationFormItem[];
Items: EvaluationFormItem[] | undefined;

/**
* <p>The scoring weight of the section.</p>
Expand Down
33 changes: 18 additions & 15 deletions codegen/sdk-codegen/aws-models/connect.json
View file
Expand Up @@ -155,7 +155,7 @@
"EvaluationFormVersion": {
"target": "com.amazonaws.connect#VersionNumber",
"traits": {
"smithy.api#documentation": "<p>The version of the evaluation form to activate. If the version property is not provided, the\n latest version of the evaluation form is activated.</p>",
"smithy.api#documentation": "<p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the\n evaluation form is activated.</p>",
"smithy.api#required": {}
}
}
Expand Down Expand Up @@ -4288,7 +4288,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Creates an evaluation form in the specified Amazon Connect instance. The form can be\n used to define questions related to agent performance, and create sections to organize such\n questions. Question and section identifiers cannot be duplicated within the same evaluation\n form.</p>",
"smithy.api#documentation": "<p>Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define\n questions related to agent performance, and create sections to organize such questions. Question and section identifiers\n cannot be duplicated within the same evaluation form.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/evaluation-forms/{InstanceId}",
Expand Down Expand Up @@ -4712,7 +4712,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Adds a new participant into an on-going chat contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html\">Customize chat\n flow experiences by integrating custom participants</a>.</p>",
"smithy.api#documentation": "<p>Adds a new participant into an on-going chat contact. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html\">Customize chat\n flow experiences by integrating custom participants</a>.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/contact/create-participant",
Expand Down Expand Up @@ -4762,7 +4762,7 @@
"ParticipantCredentials": {
"target": "com.amazonaws.connect#ParticipantTokenCredentials",
"traits": {
"smithy.api#documentation": "<p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The\n participant token is valid for the lifetime of a chat participant.</p>"
"smithy.api#documentation": "<p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant\n token is valid for the lifetime of a chat participant.</p>"
}
},
"ParticipantId": {
Expand Down Expand Up @@ -6563,7 +6563,8 @@
"method": "DELETE",
"uri": "/contact-evaluations/{InstanceId}/{EvaluationId}",
"code": 200
}
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.connect#DeleteContactEvaluationRequest": {
Expand Down Expand Up @@ -6752,12 +6753,13 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes an evaluation form in the specified Amazon Connect instance. </p>\n <ul>\n <li>\n <p>If the version property is provided, only the specified version of the evaluation form is\n deleted.</p>\n </li>\n <li>\n <p>If no version is provided, then the full form (all versions) is deleted.</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>Deletes an evaluation form in the specified Amazon Connect instance. </p>\n <ul>\n <li>\n <p>If the version\n property is provided, only the specified version of the evaluation form is deleted.</p>\n </li>\n <li>\n <p>If no version is provided, then the full form (all versions) is deleted.</p>\n </li>\n </ul>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}",
"code": 200
}
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.connect#DeleteEvaluationFormRequest": {
Expand Down Expand Up @@ -10394,7 +10396,7 @@
},
"traits": {
"smithy.api#length": {
"min": 0,
"min": 1,
"max": 100
}
}
Expand Down Expand Up @@ -10707,7 +10709,8 @@
"Items": {
"target": "com.amazonaws.connect#EvaluationFormItemsList",
"traits": {
"smithy.api#documentation": "<p>The items of the section.</p>"
"smithy.api#documentation": "<p>The items of the section.</p>",
"smithy.api#required": {}
}
},
"Weight": {
Expand Down Expand Up @@ -10971,7 +10974,7 @@
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"min": 1,
"max": 128
}
}
Expand Down Expand Up @@ -17535,7 +17538,7 @@
"MetricFilterKey": {
"target": "com.amazonaws.connect#String",
"traits": {
"smithy.api#documentation": "<p>The key to use for filtering data. </p>\n <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.\n These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>\n in the contact record. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord\">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's\n Guide</i>. </p>"
"smithy.api#documentation": "<p>The key to use for filtering data. </p>\n <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.\n These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>\n in the contact record. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord\">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>"
}
},
"MetricFilterValues": {
Expand Down Expand Up @@ -20738,7 +20741,7 @@
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"min": 1,
"max": 40
}
}
Expand Down Expand Up @@ -21109,7 +21112,7 @@
"traits": {
"smithy.api#length": {
"min": 1,
"max": 50
"max": 500
}
}
},
Expand Down Expand Up @@ -22887,7 +22890,7 @@
"Condition": {
"target": "com.amazonaws.connect#SingleSelectQuestionRuleCategoryAutomationCondition",
"traits": {
"smithy.api#documentation": "<p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,\n then the option is applied when the contact data includes the category. Similarly, if the\n condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not\n include the category.</p>",
"smithy.api#documentation": "<p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>, then the\n option is applied when the contact data includes the category. Similarly, if the condition is\n <code>NOT_PRESENT</code>, then the option is applied when the contact data does not include the\n category.</p>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -26024,7 +26027,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Updates details about a specific evaluation form version in the specified Amazon Connect\n instance. Question and section identifiers cannot be duplicated within the same evaluation\n form.</p>\n <p>This operation does not support partial updates. Instead it does a full update of evaluation\n form content.</p>",
"smithy.api#documentation": "<p>Updates details about a specific evaluation form version in the specified Amazon Connect\n instance. Question and section\n identifiers cannot be duplicated within the same evaluation form.</p>\n <p>This operation does not support partial updates. Instead it does a full update of evaluation form content.</p>",
"smithy.api#http": {
"method": "PUT",
"uri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}",
Expand Down

0 comments on commit 60a8a56

Please sign in to comment.