@aws-sdk/client-connect 3.319.0 → 3.320.0

package/dist-types/commands/UpdateEvaluationFormCommand.d.ts

@@ -0,0 +1,215 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
+import { UpdateEvaluationFormRequest, UpdateEvaluationFormResponse } from "../models/models_1";
+/**
+ * @public
+ *
+ * The input for {@link UpdateEvaluationFormCommand}.
+ */
+export interface UpdateEvaluationFormCommandInput extends UpdateEvaluationFormRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateEvaluationFormCommand}.
+ */
+export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates details about a specific evaluation form version in the specified Amazon Connect
+ *    instance. An evaluation form must have a unique title within an 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
+ * import { ConnectClient, UpdateEvaluationFormCommand } from "@aws-sdk/client-connect"; // ES Modules import
+ * // const { ConnectClient, UpdateEvaluationFormCommand } = require("@aws-sdk/client-connect"); // CommonJS import
+ * const client = new ConnectClient(config);
+ * const input = { // UpdateEvaluationFormRequest
+ *   InstanceId: "STRING_VALUE", // required
+ *   EvaluationFormId: "STRING_VALUE", // required
+ *   EvaluationFormVersion: Number("int"), // required
+ *   CreateNewVersion: true || false,
+ *   Title: "STRING_VALUE", // required
+ *   Description: "STRING_VALUE",
+ *   Items: [ // EvaluationFormItemsList // required
+ *     { // EvaluationFormItem Union: only one key present
+ *       Section: { // EvaluationFormSection
+ *         Title: "STRING_VALUE", // required
+ *         RefId: "STRING_VALUE", // required
+ *         Instructions: "STRING_VALUE",
+ *         Items: [
+ *           {//  Union: only one key present
+ *             Section: {
+ *               Title: "STRING_VALUE", // required
+ *               RefId: "STRING_VALUE", // required
+ *               Instructions: "STRING_VALUE",
+ *               Items: "<EvaluationFormItemsList>",
+ *               Weight: Number("double"),
+ *             },
+ *             Question: { // EvaluationFormQuestion
+ *               Title: "STRING_VALUE", // required
+ *               Instructions: "STRING_VALUE",
+ *               RefId: "STRING_VALUE", // required
+ *               NotApplicableEnabled: true || false,
+ *               QuestionType: "TEXT" || "SINGLESELECT" || "NUMERIC", // required
+ *               QuestionTypeProperties: { // EvaluationFormQuestionTypeProperties Union: only one key present
+ *                 Numeric: { // EvaluationFormNumericQuestionProperties
+ *                   MinValue: Number("int"), // required
+ *                   MaxValue: Number("int"), // required
+ *                   Options: [ // EvaluationFormNumericQuestionOptionList
+ *                     { // EvaluationFormNumericQuestionOption
+ *                       MinValue: Number("int"), // required
+ *                       MaxValue: Number("int"), // required
+ *                       Score: Number("int"),
+ *                       AutomaticFail: true || false,
+ *                     },
+ *                   ],
+ *                   Automation: { // EvaluationFormNumericQuestionAutomation Union: only one key present
+ *                     PropertyValue: { // NumericQuestionPropertyValueAutomation
+ *                       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
+ *                     },
+ *                   },
+ *                 },
+ *                 SingleSelect: { // EvaluationFormSingleSelectQuestionProperties
+ *                   Options: [ // EvaluationFormSingleSelectQuestionOptionList // required
+ *                     { // EvaluationFormSingleSelectQuestionOption
+ *                       RefId: "STRING_VALUE", // required
+ *                       Text: "STRING_VALUE", // required
+ *                       Score: Number("int"),
+ *                       AutomaticFail: true || false,
+ *                     },
+ *                   ],
+ *                   DisplayAs: "DROPDOWN" || "RADIO",
+ *                   Automation: { // EvaluationFormSingleSelectQuestionAutomation
+ *                     Options: [ // EvaluationFormSingleSelectQuestionAutomationOptionList // required
+ *                       { // EvaluationFormSingleSelectQuestionAutomationOption Union: only one key present
+ *                         RuleCategory: { // SingleSelectQuestionRuleCategoryAutomation
+ *                           Category: "STRING_VALUE", // required
+ *                           Condition: "PRESENT" || "NOT_PRESENT", // required
+ *                           OptionRefId: "STRING_VALUE", // required
+ *                         },
+ *                       },
+ *                     ],
+ *                     DefaultOptionRefId: "STRING_VALUE",
+ *                   },
+ *                 },
+ *               },
+ *               Weight: Number("double"),
+ *             },
+ *           },
+ *         ],
+ *         Weight: Number("double"),
+ *       },
+ *       Question: {
+ *         Title: "STRING_VALUE", // required
+ *         Instructions: "STRING_VALUE",
+ *         RefId: "STRING_VALUE", // required
+ *         NotApplicableEnabled: true || false,
+ *         QuestionType: "TEXT" || "SINGLESELECT" || "NUMERIC", // required
+ *         QuestionTypeProperties: {//  Union: only one key present
+ *           Numeric: {
+ *             MinValue: Number("int"), // required
+ *             MaxValue: Number("int"), // required
+ *             Options: [
+ *               {
+ *                 MinValue: Number("int"), // required
+ *                 MaxValue: Number("int"), // required
+ *                 Score: Number("int"),
+ *                 AutomaticFail: true || false,
+ *               },
+ *             ],
+ *             Automation: {//  Union: only one key present
+ *               PropertyValue: {
+ *                 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
+ *               },
+ *             },
+ *           },
+ *           SingleSelect: {
+ *             Options: [ // required
+ *               {
+ *                 RefId: "STRING_VALUE", // required
+ *                 Text: "STRING_VALUE", // required
+ *                 Score: Number("int"),
+ *                 AutomaticFail: true || false,
+ *               },
+ *             ],
+ *             DisplayAs: "DROPDOWN" || "RADIO",
+ *             Automation: {
+ *               Options: [ // required
+ *                 {//  Union: only one key present
+ *                   RuleCategory: {
+ *                     Category: "STRING_VALUE", // required
+ *                     Condition: "PRESENT" || "NOT_PRESENT", // required
+ *                     OptionRefId: "STRING_VALUE", // required
+ *                   },
+ *                 },
+ *               ],
+ *               DefaultOptionRefId: "STRING_VALUE",
+ *             },
+ *           },
+ *         },
+ *         Weight: Number("double"),
+ *       },
+ *     },
+ *   ],
+ *   ScoringStrategy: { // EvaluationFormScoringStrategy
+ *     Mode: "QUESTION_ONLY" || "SECTION_ONLY", // required
+ *     Status: "ENABLED" || "DISABLED", // required
+ *   },
+ *   ClientToken: "STRING_VALUE",
+ * };
+ * const command = new UpdateEvaluationFormCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param UpdateEvaluationFormCommandInput - {@link UpdateEvaluationFormCommandInput}
+ * @returns {@link UpdateEvaluationFormCommandOutput}
+ * @see {@link UpdateEvaluationFormCommandInput} for command's `input` shape.
+ * @see {@link UpdateEvaluationFormCommandOutput} for command's `response` shape.
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>Request processing failed because of an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more of the specified parameters are not valid.</p>
+ *
+ * @throws {@link ResourceConflictException} (client fault)
+ *  <p>A resource already has that name.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The service quota has been exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ *
+ */
+export declare class UpdateEvaluationFormCommand extends $Command<UpdateEvaluationFormCommandInput, UpdateEvaluationFormCommandOutput, ConnectClientResolvedConfig> {
+    readonly input: UpdateEvaluationFormCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateEvaluationFormCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEvaluationFormCommandInput, UpdateEvaluationFormCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./ActivateEvaluationFormCommand";
 export * from "./AssociateApprovedOriginCommand";
 export * from "./AssociateBotCommand";
 export * from "./AssociateDefaultVocabularyCommand";
@@ -12,6 +13,7 @@ export * from "./ClaimPhoneNumberCommand";
 export * from "./CreateAgentStatusCommand";
 export * from "./CreateContactFlowCommand";
 export * from "./CreateContactFlowModuleCommand";
+export * from "./CreateEvaluationFormCommand";
 export * from "./CreateHoursOfOperationCommand";
 export * from "./CreateInstanceCommand";
 export * from "./CreateIntegrationAssociationCommand";
@@ -27,8 +29,11 @@ export * from "./CreateUseCaseCommand";
 export * from "./CreateUserCommand";
 export * from "./CreateUserHierarchyGroupCommand";
 export * from "./CreateVocabularyCommand";
+export * from "./DeactivateEvaluationFormCommand";
+export * from "./DeleteContactEvaluationCommand";
 export * from "./DeleteContactFlowCommand";
 export * from "./DeleteContactFlowModuleCommand";
+export * from "./DeleteEvaluationFormCommand";
 export * from "./DeleteHoursOfOperationCommand";
 export * from "./DeleteInstanceCommand";
 export * from "./DeleteIntegrationAssociationCommand";
@@ -43,8 +48,10 @@ export * from "./DeleteUserHierarchyGroupCommand";
 export * from "./DeleteVocabularyCommand";
 export * from "./DescribeAgentStatusCommand";
 export * from "./DescribeContactCommand";
+export * from "./DescribeContactEvaluationCommand";
 export * from "./DescribeContactFlowCommand";
 export * from "./DescribeContactFlowModuleCommand";
+export * from "./DescribeEvaluationFormCommand";
 export * from "./DescribeHoursOfOperationCommand";
 export * from "./DescribeInstanceAttributeCommand";
 export * from "./DescribeInstanceCommand";
@@ -81,10 +88,13 @@ export * from "./GetTrafficDistributionCommand";
 export * from "./ListAgentStatusesCommand";
 export * from "./ListApprovedOriginsCommand";
 export * from "./ListBotsCommand";
+export * from "./ListContactEvaluationsCommand";
 export * from "./ListContactFlowModulesCommand";
 export * from "./ListContactFlowsCommand";
 export * from "./ListContactReferencesCommand";
 export * from "./ListDefaultVocabulariesCommand";
+export * from "./ListEvaluationFormVersionsCommand";
+export * from "./ListEvaluationFormsCommand";
 export * from "./ListHoursOfOperationsCommand";
 export * from "./ListInstanceAttributesCommand";
 export * from "./ListInstanceStorageConfigsCommand";
@@ -122,6 +132,7 @@ export * from "./SearchSecurityProfilesCommand";
 export * from "./SearchUsersCommand";
 export * from "./SearchVocabulariesCommand";
 export * from "./StartChatContactCommand";
+export * from "./StartContactEvaluationCommand";
 export * from "./StartContactRecordingCommand";
 export * from "./StartContactStreamingCommand";
 export * from "./StartOutboundVoiceContactCommand";
@@ -129,6 +140,7 @@ export * from "./StartTaskContactCommand";
 export * from "./StopContactCommand";
 export * from "./StopContactRecordingCommand";
 export * from "./StopContactStreamingCommand";
+export * from "./SubmitContactEvaluationCommand";
 export * from "./SuspendContactRecordingCommand";
 export * from "./TagResourceCommand";
 export * from "./TransferContactCommand";
@@ -136,12 +148,14 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateAgentStatusCommand";
 export * from "./UpdateContactAttributesCommand";
 export * from "./UpdateContactCommand";
+export * from "./UpdateContactEvaluationCommand";
 export * from "./UpdateContactFlowContentCommand";
 export * from "./UpdateContactFlowMetadataCommand";
 export * from "./UpdateContactFlowModuleContentCommand";
 export * from "./UpdateContactFlowModuleMetadataCommand";
 export * from "./UpdateContactFlowNameCommand";
 export * from "./UpdateContactScheduleCommand";
+export * from "./UpdateEvaluationFormCommand";
 export * from "./UpdateHoursOfOperationCommand";
 export * from "./UpdateInstanceAttributeCommand";
 export * from "./UpdateInstanceStorageConfigCommand";