@aws-sdk/client-connect 3.1143.0 → 3.1145.0

package/dist-types/models/models_4.d.ts

@@ -1,8 +1,70 @@
 import type { AnsweringMachineDetectionStatus, Channel, ConnectionType, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, DisconnectOnCustomerExitParticipantType, EvaluationFormItemEnablementAction, EvaluationFormItemEnablementOperator, EvaluationFormQuestionType, EvaluationFormValidationStatus, EvaluationFormVersionStatus, InitiateAs, NotificationStatus, RoutingCriteriaStepStatus, SearchableQueueType, TaskTemplateStatus, TestCaseStatus, ViewStatus, ViewType, Visibility } from "./enums";
-import type { AdditionalEmailRecipients, AfterContactWorkConfigPerChannel, AgentConfig, AgentInfo, AgentStatusSearchFilter, AllowedCapabilities, Campaign, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormItemEnablementExpression, EvaluationFormLanguageConfiguration, EvaluationFormMetricConfiguration, EvaluationFormQuestionScoringConfiguration, EvaluationFormQuestionTypeProperties, EvaluationFormScoreThreshold, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, EvaluationReviewConfiguration, OutboundStrategy, Reference, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, UserInfo, UserProficiency } from "./models_0";
-import type { AttributeCondition, AutoAcceptConfig, ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, Expiry, GlobalResiliencyMetadata, NextContactEntry, PersistentConnectionConfig, PhoneNumberConfig, QualityMetrics, QueueInfo, RecordingInfo, TaskTemplateField, TaskTemplateInfoV2, TestCaseEntryPoint, UserIdentityInfo, UserPhoneConfig, View, ViewInputContent, VoiceEnhancementConfig, WisdomInfo, WorkspaceTheme } from "./models_1";
+import type { AdditionalEmailRecipients, AfterContactWorkConfigPerChannel, AgentConfig, AgentInfo, AgentStatusSearchFilter, AllowedCapabilities, Campaign, Endpoint, EvaluationFormAutoEvaluationConfiguration, EvaluationFormItemEnablementExpression, EvaluationFormLanguageConfiguration, EvaluationFormMetricConfiguration, EvaluationFormQuestionScoringConfiguration, EvaluationFormQuestionTypeProperties, EvaluationFormScoreThreshold, EvaluationFormScoringStrategy, EvaluationFormTargetConfiguration, EvaluationReviewConfiguration, OutboundStrategy, Reference, StringCondition, TaskTemplateConstraints, UserInfo, UserProficiency } from "./models_0";
+import type { AttributeCondition, AutoAcceptConfig, ChatMetrics, ContactDetails, ContactEvaluation, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, Expiry, GlobalResiliencyMetadata, NextContactEntry, PersistentConnectionConfig, PhoneNumberConfig, QualityMetrics, QueueInfo, RecordingInfo, TaskTemplateDefaults, TaskTemplateField, TaskTemplateInfoV2, TestCaseEntryPoint, UserIdentityInfo, UserPhoneConfig, View, ViewInputContent, VoiceEnhancementConfig, WisdomInfo, WorkspaceTheme } from "./models_1";
 import type { SignInConfig, TelephonyConfig } from "./models_2";
 import type { BooleanCondition, ChatMessage, ChatStreamingConfiguration, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, ContactSearchSummaryAgentInfo, ContactSearchSummaryAiAgentInfo, ContactSearchSummaryQueueInfo, DataTableSearchFilter, DateCondition, DateTimeCondition, DecimalCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, EvaluationFormSearchFilter, EvaluationSearchFilter, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, MetricSearchFilter, NotificationSearchFilter, NumberCondition, ParticipantConfiguration, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, RulesSearchFilter, SecurityProfilesSearchFilter, TaskAttachment, TemplatedMessageConfig, TestCaseSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter, ViewSearchFilter, WorkspaceAssociationSearchFilter, WorkspaceSearchFilter } from "./models_3";
+/**
+ * @public
+ */
+export interface UpdateTaskTemplateRequest {
+    /**
+     * <p>A unique identifier for the task template.</p>
+     * @public
+     */
+    TaskTemplateId: string | undefined;
+    /**
+     * <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>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The name of the task template.</p>
+     * @public
+     */
+    Name?: string | undefined;
+    /**
+     * <p>The description of the task template.</p>
+     * @public
+     */
+    Description?: string | undefined;
+    /**
+     * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
+     *          <p>Although this parameter is marked as optional, the request must contain either a <code>ContactFlowId</code> or a field of type <code>QUICK_CONNECT</code>.</p>
+     * @public
+     */
+    ContactFlowId?: string | undefined;
+    /**
+     * <p>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</p>
+     * @public
+     */
+    SelfAssignFlowId?: string | undefined;
+    /**
+     * <p>Constraints that are applicable to the fields listed.
+     * Although this parameter is marked as optional in the API model, the service requires it when calling <code>CreateTaskTemplate</code> or <code>UpdateTaskTemplate</code>.
+     * The <code>RequiredFields</code> array must contain at least one element, and the field of type <code>NAME</code> must be included in <code>RequiredFields</code>.</p>
+     * @public
+     */
+    Constraints?: TaskTemplateConstraints | undefined;
+    /**
+     * <p>The default values for fields when a task is created by referencing this template.</p>
+     * @public
+     */
+    Defaults?: TaskTemplateDefaults | undefined;
+    /**
+     * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
+     * Tasks can only be created from <code>ACTIVE</code> templates.
+     * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
+     *          <p>Although this parameter is marked as optional, the service requires it when calling <code>UpdateTaskTemplate</code>.</p>
+     * @public
+     */
+    Status?: TaskTemplateStatus | undefined;
+    /**
+     * <p>Fields that are part of the template.</p>
+     *          <p>The request must contain exactly one field of type <code>NAME</code>. This field must also be listed in the <code>RequiredFields</code> array within the <code>Constraints</code> parameter.</p>
+     * @public
+     */
+    Fields?: TaskTemplateField[] | undefined;
+}
 /**
  * @public
  */
@@ -2597,14 +2659,27 @@ export interface StartChatContactRequest {
     DisconnectOnCustomerExit?: DisconnectOnCustomerExitParticipantType[] | undefined;
     /**
      * <p>The types of connection information to return in the response. This parameter is optional.</p>
-     *          <p>Specify <code>CONNECTION_CREDENTIALS</code> to receive a connection token. Specify <code>WEBSOCKET</code> to
-     *    receive a websocket URL. You can specify both. No other value returns connection information.</p>
+     *          <p>To receive connection information, specify one or both of the following values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>CONNECTION_CREDENTIALS</code>: Returns a connection token.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>WEBSOCKET</code>: Returns a websocket URL.</p>
+     *             </li>
+     *          </ul>
+     *          <p>
+     *             <code>WEBSOCKET</code> and <code>CONNECTION_CREDENTIALS</code> are the values this operation acts on. No other
+     *    value returns connection information.</p>
      *          <p>Request <code>WEBSOCKET</code> to get a URL the participant connects to directly. You do not need to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> for it. Request <code>CONNECTION_CREDENTIALS</code> on its own and the response
      *    returns a connection token but no websocket URL.</p>
      *          <p>If you omit this parameter, the response has no connection information.</p>
      *          <note>
-     *             <p>If the information you request cannot be returned, StartChatContact returns an error rather than a response that
-     *     omits it.</p>
+     *             <p>When you start a new chat contact and the information you request cannot be returned, StartChatContact returns
+     *     an error rather than a response that omits it. When you retry a request with the same <code>ClientToken</code>, the
+     *     response repeats the original contact and can omit a websocket URL if the chat has already ended.</p>
      *          </note>
      * @public
      */
@@ -2612,7 +2687,7 @@ export interface StartChatContactRequest {
     /**
      * <p>The streaming configuration, such as the Amazon SNS streaming endpoint. Use it to initiate real-time
      *    message streaming when the chat is created. This parameter is optional.</p>
-     *          <p>When you set this parameter, the response includes <code>StreamingId</code>. You do not need to call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>.</p>
+     *          <p>Setting this parameter returns a <code>StreamingId</code> in the response, and you do not need to call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>.</p>
      *          <note>
      *             <p>This parameter starts message streaming only. The response does not include connection information, and setting
      *     this parameter does not remove the need to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>.</p>

package/dist-types/schemas/schemas_0.d.ts

@@ -1060,6 +1060,7 @@ export declare var SecurityProfileSummary$: StaticStructureSchema;
 export declare var SegmentAttributeValue$: StaticStructureSchema;
 export declare var SendChatIntegrationEventRequest$: StaticStructureSchema;
 export declare var SendChatIntegrationEventResponse$: StaticStructureSchema;
+export declare var SendInAppNotificationActionDefinition$: StaticStructureSchema;
 export declare var SendNotificationActionDefinition$: StaticStructureSchema;
 export declare var SendOutboundEmailRequest$: StaticStructureSchema;
 export declare var SendOutboundEmailResponse$: StaticStructureSchema;

package/dist-types/ts3.4/commands/GetContactMetricsCommand.d.ts

@@ -1,6 +1,5 @@
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { GetContactMetricsRequest } from "../models/models_1";
-import { GetContactMetricsResponse } from "../models/models_2";
+import { GetContactMetricsRequest, GetContactMetricsResponse } from "../models/models_2";
 export { __MetadataBearer };
 export interface GetContactMetricsCommandInput extends GetContactMetricsRequest {}
 export interface GetContactMetricsCommandOutput

package/dist-types/ts3.4/commands/PauseContactCommand.d.ts

@@ -1,5 +1,6 @@
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { PauseContactRequest, PauseContactResponse } from "../models/models_2";
+import { PauseContactRequest } from "../models/models_2";
+import { PauseContactResponse } from "../models/models_3";
 export { __MetadataBearer };
 export interface PauseContactCommandInput extends PauseContactRequest {}
 export interface PauseContactCommandOutput extends PauseContactResponse, __MetadataBearer {}

package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts

@@ -1,6 +1,5 @@
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { UpdateTaskTemplateRequest } from "../models/models_3";
-import { UpdateTaskTemplateResponse } from "../models/models_4";
+import { UpdateTaskTemplateRequest, UpdateTaskTemplateResponse } from "../models/models_4";
 export { __MetadataBearer };
 export interface UpdateTaskTemplateCommandInput extends UpdateTaskTemplateRequest {}
 export interface UpdateTaskTemplateCommandOutput

package/dist-types/ts3.4/models/enums.d.ts

@@ -10,6 +10,7 @@ export declare const ActionType: {
   readonly END_ASSOCIATED_TASKS: "END_ASSOCIATED_TASKS";
   readonly EXTRACT_INFORMATION: "EXTRACT_INFORMATION";
   readonly GENERATE_EVENTBRIDGE_EVENT: "GENERATE_EVENTBRIDGE_EVENT";
+  readonly SEND_IN_APP_NOTIFICATION: "SEND_IN_APP_NOTIFICATION";
   readonly SEND_NOTIFICATION: "SEND_NOTIFICATION";
   readonly SUBMIT_AUTO_EVALUATION: "SUBMIT_AUTO_EVALUATION";
   readonly UPDATE_CASE: "UPDATE_CASE";

package/dist-types/ts3.4/models/models_0.d.ts

@@ -1596,6 +1596,12 @@ export interface NotificationRecipientType {
   UserTags?: Record<string, string> | undefined;
   UserIds?: string[] | undefined;
 }
+export interface SendInAppNotificationActionDefinition {
+  Content: Partial<Record<LocaleCode, string>> | undefined;
+  Recipient: NotificationRecipientType | undefined;
+  Exclusion?: NotificationRecipientType | undefined;
+  Priority?: ConfigurableNotificationPriority | undefined;
+}
 export interface SendNotificationActionDefinition {
   DeliveryMethod: NotificationDeliveryType | undefined;
   Subject?: string | undefined;
@@ -1628,6 +1634,7 @@ export interface RuleAction {
   EndAssociatedTasksAction?: EndAssociatedTasksActionDefinition | undefined;
   SubmitAutoEvaluationAction?: SubmitAutoEvaluationActionDefinition | undefined;
   ExtractInformationAction?: ExtractInformationActionDefinition | undefined;
+  SendInAppNotificationAction?: SendInAppNotificationActionDefinition | undefined;
 }
 export interface PreEvaluationFilter {
   ResourceType: PreEvaluationFilterResourceType | undefined;
@@ -1719,6 +1726,3 @@ export interface TaskTemplateDefaultFieldValue {
   Id?: TaskTemplateFieldIdentifier | undefined;
   DefaultValue?: string | undefined;
 }
-export interface TaskTemplateDefaults {
-  DefaultFieldValues?: TaskTemplateDefaultFieldValue[] | undefined;
-}

package/dist-types/ts3.4/models/models_1.d.ts

@@ -108,10 +108,13 @@ import {
   SecurityProfileItem,
   SuccessfulBatchAssociationSummary,
   TaskTemplateConstraints,
-  TaskTemplateDefaults,
+  TaskTemplateDefaultFieldValue,
   TaskTemplateFieldIdentifier,
   Validation,
 } from "./models_0";
+export interface TaskTemplateDefaults {
+  DefaultFieldValues?: TaskTemplateDefaultFieldValue[] | undefined;
+}
 export interface TaskTemplateField {
   Id: TaskTemplateFieldIdentifier | undefined;
   Description?: string | undefined;
@@ -1777,8 +1780,3 @@ export interface GetContactAttributesResponse {
 export interface ContactMetricInfo {
   Name: ContactMetricName | undefined;
 }
-export interface GetContactMetricsRequest {
-  InstanceId: string | undefined;
-  ContactId: string | undefined;
-  Metrics: ContactMetricInfo[] | undefined;
-}

package/dist-types/ts3.4/models/models_2.d.ts

@@ -97,11 +97,11 @@ import {
   QueueReference,
   SecurityProfileItem,
   TaskTemplateConstraints,
-  TaskTemplateDefaults,
   UserProficiency,
 } from "./models_0";
 import {
   Attribute,
+  ContactMetricInfo,
   DataTableAttribute,
   EvaluationContactParticipant,
   EvaluationScore,
@@ -110,8 +110,14 @@ import {
   HoursOfOperationOverride,
   HoursOfOperationsIdentifier,
   Notification,
+  TaskTemplateDefaults,
   TaskTemplateField,
 } from "./models_1";
+export interface GetContactMetricsRequest {
+  InstanceId: string | undefined;
+  ContactId: string | undefined;
+  Metrics: ContactMetricInfo[] | undefined;
+}
 export type ContactMetricValue =
   | ContactMetricValue.NumberMember
   | ContactMetricValue.$UnknownMember;
@@ -2082,4 +2088,3 @@ export interface PauseContactRequest {
   InstanceId: string | undefined;
   ContactFlowId?: string | undefined;
 }
-export interface PauseContactResponse {}

package/dist-types/ts3.4/models/models_3.d.ts

@@ -65,7 +65,6 @@ import {
   StringComparisonType,
   SummaryMode,
   TargetListType,
-  TaskTemplateStatus,
   TestCaseExecutionStatus,
   TimerEligibleParticipantRoles,
   TrafficType,
@@ -112,8 +111,6 @@ import {
   RuleTriggerEventSource,
   StringCondition,
   TagCondition,
-  TaskTemplateConstraints,
-  TaskTemplateDefaults,
   Validation,
 } from "./models_0";
 import {
@@ -135,12 +132,12 @@ import {
   Queue,
   QuickConnect,
   RoutingProfile,
-  TaskTemplateField,
   TestCase,
   UserPhoneConfig,
   View,
   VoiceEnhancementConfig,
 } from "./models_1";
+export interface PauseContactResponse {}
 export interface PutUserStatusRequest {
   UserId: string | undefined;
   InstanceId: string | undefined;
@@ -1652,15 +1649,3 @@ export interface UpdateSecurityProfileRequest {
   AllowedAIAgents?: AIAgent[] | undefined;
   GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined;
 }
-export interface UpdateTaskTemplateRequest {
-  TaskTemplateId: string | undefined;
-  InstanceId: string | undefined;
-  Name?: string | undefined;
-  Description?: string | undefined;
-  ContactFlowId?: string | undefined;
-  SelfAssignFlowId?: string | undefined;
-  Constraints?: TaskTemplateConstraints | undefined;
-  Defaults?: TaskTemplateDefaults | undefined;
-  Status?: TaskTemplateStatus | undefined;
-  Fields?: TaskTemplateField[] | undefined;
-}

package/dist-types/ts3.4/models/models_4.d.ts

@@ -47,7 +47,6 @@ import {
   Reference,
   StringCondition,
   TaskTemplateConstraints,
-  TaskTemplateDefaults,
   UserInfo,
   UserProficiency,
 } from "./models_0";
@@ -70,6 +69,7 @@ import {
   QualityMetrics,
   QueueInfo,
   RecordingInfo,
+  TaskTemplateDefaults,
   TaskTemplateField,
   TaskTemplateInfoV2,
   TestCaseEntryPoint,
@@ -128,6 +128,18 @@ import {
   WorkspaceAssociationSearchFilter,
   WorkspaceSearchFilter,
 } from "./models_3";
+export interface UpdateTaskTemplateRequest {
+  TaskTemplateId: string | undefined;
+  InstanceId: string | undefined;
+  Name?: string | undefined;
+  Description?: string | undefined;
+  ContactFlowId?: string | undefined;
+  SelfAssignFlowId?: string | undefined;
+  Constraints?: TaskTemplateConstraints | undefined;
+  Defaults?: TaskTemplateDefaults | undefined;
+  Status?: TaskTemplateStatus | undefined;
+  Fields?: TaskTemplateField[] | undefined;
+}
 export interface UpdateTaskTemplateResponse {
   InstanceId?: string | undefined;
   Id?: string | undefined;

package/dist-types/ts3.4/schemas/schemas_0.d.ts

@@ -1060,6 +1060,7 @@ export declare var SecurityProfileSummary$: StaticStructureSchema;
 export declare var SegmentAttributeValue$: StaticStructureSchema;
 export declare var SendChatIntegrationEventRequest$: StaticStructureSchema;
 export declare var SendChatIntegrationEventResponse$: StaticStructureSchema;
+export declare var SendInAppNotificationActionDefinition$: StaticStructureSchema;
 export declare var SendNotificationActionDefinition$: StaticStructureSchema;
 export declare var SendOutboundEmailRequest$: StaticStructureSchema;
 export declare var SendOutboundEmailResponse$: StaticStructureSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/client-connect",
-  "version": "3.1143.0",
+  "version": "3.1145.0",
   "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
   "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-connect",
   "license": "Apache-2.0",