@aws-sdk/client-connect 3.835.0 → 3.840.0

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

@@ -1,6 +1,61 @@
 import { AdditionalEmailRecipients, AgentAvailabilityTimer, AgentConfig, AgentInfo, AgentStatusSearchFilter, Application, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, Endpoint, EvaluationFormQuestion, EvaluationFormScoringStrategy, InitiateAs, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, PredefinedAttributeValues, QuickConnectConfig, Reference, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus } from "./models_0";
-import { AnsweringMachineDetectionStatus, AttributeCondition, ContactDetails, ContactEvaluation, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, QueueStatus, RecordingInfo, RoutingCriteriaStepStatus, SignInConfig, TelephonyConfig, WisdomInfo } from "./models_1";
-import { ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
+import { AnsweringMachineDetectionStatus, AttributeCondition, ChatMetrics, ContactDetails, ContactEvaluation, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, QueueStatus, RecordingInfo, RoutingCriteriaStepStatus, SignInConfig, TelephonyConfig, WisdomInfo } from "./models_1";
+import { ChatMessage, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, DateCondition, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UpdateParticipantRoleConfigChannelInfo, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
+/**
+ * @public
+ */
+export interface UpdateParticipantRoleConfigRequest {
+    /**
+     * <p>The identifier of the Amazon Connect 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 identifier of the contact in this instance of Amazon Connect. </p>
+     * @public
+     */
+    ContactId: string | undefined;
+    /**
+     * <p>The Amazon Connect channel you want to configure.</p>
+     * @public
+     */
+    ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateParticipantRoleConfigResponse {
+}
+/**
+ * @public
+ */
+export interface UpdatePhoneNumberRequest {
+    /**
+     * <p>A unique identifier for the phone number.</p>
+     * @public
+     */
+    PhoneNumberId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
+     * @public
+     */
+    TargetArn?: string | undefined;
+    /**
+     * <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. 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. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
+     * @public
+     */
+    InstanceId?: string | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
+     *             request. If not provided, the Amazon Web Services
+     *             SDK populates this field. For more information about idempotency, see
+     *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
+     * @public
+     */
+    ClientToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -1145,16 +1200,16 @@ export interface CreateContactRequest {
     Attributes?: Record<string, string> | undefined;
     /**
      * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
-     *    the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL |
-     *    ATTACHMENT.</p>
+     *    the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
+     *     <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code> | <code>ATTACHMENT</code>.</p>
      * @public
      */
     References?: Record<string, Reference> | undefined;
     /**
-     * <p>The channel for the contact</p>
+     * <p>The channel for the contact.</p>
      *          <important>
-     *             <p>CreateContact only supports the EMAIL and VOICE channels. The following information that
-     *     states other channels are supported is incorrect. We are working to update this topic.</p>
+     *             <p>The CHAT channel is not supported. The following information is incorrect. We're working to
+     *     correct it.</p>
      *          </important>
      * @public
      */
@@ -1162,17 +1217,23 @@ export interface CreateContactRequest {
     /**
      * <p>Indicates how the contact was initiated. </p>
      *          <important>
-     *             <p>CreateContact only supports the following initiation methods: </p>
+     *             <p>CreateContact only supports the following initiation methods. Valid values by channel are: </p>
      *             <ul>
      *                <li>
-     *                   <p>For EMAIL: OUTBOUND, AGENT_REPLY, and FLOW. </p>
+     *                   <p>For VOICE: <code>TRANSFER</code> and the subtype <code>connect:ExternalAudio</code>
+     *                   </p>
      *                </li>
      *                <li>
-     *                   <p>For VOICE: TRANSFER and the subtype connect:ExternalAudio. </p>
+     *                   <p>For EMAIL: <code>OUTBOUND</code> | <code>AGENT_REPLY</code> | <code>FLOW</code>
+     *                   </p>
+     *                </li>
+     *                <li>
+     *                   <p>For TASK: <code>API</code>
+     *                   </p>
      *                </li>
      *             </ul>
-     *             <p>The following information that states other initiation methods are supported is incorrect.
-     *     We are working to update this topic.</p>
+     *             <p>The other channels listed below are incorrect. We're working to correct this
+     *     information.</p>
      *          </important>
      * @public
      */
@@ -1184,11 +1245,16 @@ export interface CreateContactRequest {
     ExpiryDurationInMinutes?: number | undefined;
     /**
      * <p>User details for the contact</p>
+     *          <important>
+     *             <p>UserInfo is required when creating an EMAIL contact with <code>OUTBOUND</code> and
+     *      <code>AGENT_REPLY</code> contact initiation methods.</p>
+     *          </important>
      * @public
      */
     UserInfo?: UserInfo | undefined;
     /**
-     * <p>Initial state of the contact when it's created</p>
+     * <p>Initial state of the contact when it's created. Only TASK channel contacts can be initiated
+     *    with <code>COMPLETED</code> state.</p>
      * @public
      */
     InitiateAs?: InitiateAs | undefined;
@@ -1677,8 +1743,7 @@ export interface StartChatContactRequest {
      */
     ParticipantDetails: ParticipantDetails | undefined;
     /**
-     * <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
-     *    flow, the initial message is not delivered to the Lex bot.</p>
+     * <p>The initial message to be sent to the newly created chat.</p>
      * @public
      */
     InitialMessage?: ChatMessage | undefined;
@@ -1768,7 +1833,7 @@ export interface StartEmailContactRequest {
      */
     FromEmailAddress: EmailAddressInfo | undefined;
     /**
-     * <p>The email address associated with the instance.</p>
+     * <p>The email address associated with the Amazon Connect instance.</p>
      * @public
      */
     DestinationEmailAddress: string | undefined;
@@ -3110,6 +3175,11 @@ export interface Contact {
      * @public
      */
     QualityMetrics?: QualityMetrics | undefined;
+    /**
+     * <p>Information about how agent, bot, and customer interact in a chat contact.</p>
+     * @public
+     */
+    ChatMetrics?: ChatMetrics | undefined;
     /**
      * <p>Information about the call disconnect experience.</p>
      * @public

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

@@ -5,10 +5,8 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../ConnectClient";
-import {
-  ListPhoneNumbersRequest,
-  ListPhoneNumbersResponse,
-} from "../models/models_1";
+import { ListPhoneNumbersRequest } from "../models/models_1";
+import { ListPhoneNumbersResponse } from "../models/models_2";
 export { __MetadataBearer };
 export { $Command };
 export interface ListPhoneNumbersCommandInput extends ListPhoneNumbersRequest {}

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

@@ -5,8 +5,10 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../ConnectClient";
-import { ListPhoneNumbersV2Request } from "../models/models_1";
-import { ListPhoneNumbersV2Response } from "../models/models_2";
+import {
+  ListPhoneNumbersV2Request,
+  ListPhoneNumbersV2Response,
+} from "../models/models_2";
 export { __MetadataBearer };
 export { $Command };
 export interface ListPhoneNumbersV2CommandInput

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

@@ -8,7 +8,7 @@ import {
 import {
   UpdateParticipantRoleConfigRequest,
   UpdateParticipantRoleConfigResponse,
-} from "../models/models_2";
+} from "../models/models_3";
 export { __MetadataBearer };
 export { $Command };
 export interface UpdateParticipantRoleConfigCommandInput

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

@@ -5,8 +5,10 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../ConnectClient";
-import { UpdatePhoneNumberRequest } from "../models/models_2";
-import { UpdatePhoneNumberResponse } from "../models/models_3";
+import {
+  UpdatePhoneNumberRequest,
+  UpdatePhoneNumberResponse,
+} from "../models/models_3";
 export { __MetadataBearer };
 export { $Command };
 export interface UpdatePhoneNumberCommandInput

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

@@ -812,6 +812,7 @@ export declare class ConflictException extends __BaseException {
   constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 export declare const InitiateAs: {
+  readonly COMPLETED: "COMPLETED";
   readonly CONNECTED_TO_USER: "CONNECTED_TO_USER";
 };
 export type InitiateAs = (typeof InitiateAs)[keyof typeof InitiateAs];

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

@@ -182,6 +182,41 @@ export declare const AnsweringMachineDetectionStatus: {
 };
 export type AnsweringMachineDetectionStatus =
   (typeof AnsweringMachineDetectionStatus)[keyof typeof AnsweringMachineDetectionStatus];
+export declare const ParticipantType: {
+  readonly AGENT: "AGENT";
+  readonly ALL: "ALL";
+  readonly CUSTOMER: "CUSTOMER";
+  readonly MANAGER: "MANAGER";
+  readonly THIRDPARTY: "THIRDPARTY";
+};
+export type ParticipantType =
+  (typeof ParticipantType)[keyof typeof ParticipantType];
+export interface ParticipantMetrics {
+  ParticipantId?: string | undefined;
+  ParticipantType?: ParticipantType | undefined;
+  ConversationAbandon?: boolean | undefined;
+  MessagesSent?: number | undefined;
+  NumResponses?: number | undefined;
+  MessageLengthInChars?: number | undefined;
+  TotalResponseTimeInMillis?: number | undefined;
+  MaxResponseTimeInMillis?: number | undefined;
+  LastMessageTimestamp?: Date | undefined;
+}
+export interface ChatContactMetrics {
+  MultiParty?: boolean | undefined;
+  TotalMessages?: number | undefined;
+  TotalBotMessages?: number | undefined;
+  TotalBotMessageLengthInChars?: number | undefined;
+  ConversationCloseTimeInMillis?: number | undefined;
+  ConversationTurnCount?: number | undefined;
+  AgentFirstResponseTimestamp?: Date | undefined;
+  AgentFirstResponseTimeInMillis?: number | undefined;
+}
+export interface ChatMetrics {
+  ChatContactMetrics?: ChatContactMetrics | undefined;
+  AgentMetrics?: ParticipantMetrics | undefined;
+  CustomerMetrics?: ParticipantMetrics | undefined;
+}
 export interface ContactDetails {
   Name?: string | undefined;
   Description?: string | undefined;
@@ -234,15 +269,6 @@ export declare const MediaStreamType: {
 };
 export type MediaStreamType =
   (typeof MediaStreamType)[keyof typeof MediaStreamType];
-export declare const ParticipantType: {
-  readonly AGENT: "AGENT";
-  readonly ALL: "ALL";
-  readonly CUSTOMER: "CUSTOMER";
-  readonly MANAGER: "MANAGER";
-  readonly THIRDPARTY: "THIRDPARTY";
-};
-export type ParticipantType =
-  (typeof ParticipantType)[keyof typeof ParticipantType];
 export declare const RecordingStatus: {
   readonly AVAILABLE: "AVAILABLE";
   readonly DELETED: "DELETED";
@@ -2103,26 +2129,6 @@ export interface ListPhoneNumbersRequest {
   NextToken?: string | undefined;
   MaxResults?: number | undefined;
 }
-export interface PhoneNumberSummary {
-  Id?: string | undefined;
-  Arn?: string | undefined;
-  PhoneNumber?: string | undefined;
-  PhoneNumberType?: PhoneNumberType | undefined;
-  PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
-}
-export interface ListPhoneNumbersResponse {
-  PhoneNumberSummaryList?: PhoneNumberSummary[] | undefined;
-  NextToken?: string | undefined;
-}
-export interface ListPhoneNumbersV2Request {
-  TargetArn?: string | undefined;
-  InstanceId?: string | undefined;
-  MaxResults?: number | undefined;
-  NextToken?: string | undefined;
-  PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined;
-  PhoneNumberTypes?: PhoneNumberType[] | undefined;
-  PhoneNumberPrefix?: string | undefined;
-}
 export declare const DescribeEmailAddressResponseFilterSensitiveLog: (
   obj: DescribeEmailAddressResponse
 ) => any;

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

@@ -58,6 +58,26 @@ import {
   SortOrder,
   TrafficDistributionGroupStatus,
 } from "./models_1";
+export interface PhoneNumberSummary {
+  Id?: string | undefined;
+  Arn?: string | undefined;
+  PhoneNumber?: string | undefined;
+  PhoneNumberType?: PhoneNumberType | undefined;
+  PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
+}
+export interface ListPhoneNumbersResponse {
+  PhoneNumberSummaryList?: PhoneNumberSummary[] | undefined;
+  NextToken?: string | undefined;
+}
+export interface ListPhoneNumbersV2Request {
+  TargetArn?: string | undefined;
+  InstanceId?: string | undefined;
+  MaxResults?: number | undefined;
+  NextToken?: string | undefined;
+  PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined;
+  PhoneNumberTypes?: PhoneNumberType[] | undefined;
+  PhoneNumberPrefix?: string | undefined;
+}
 export interface ListPhoneNumbersSummary {
   PhoneNumberId?: string | undefined;
   PhoneNumberArn?: string | undefined;
@@ -1752,18 +1772,6 @@ export declare namespace UpdateParticipantRoleConfigChannelInfo {
     visitor: Visitor<T>
   ) => T;
 }
-export interface UpdateParticipantRoleConfigRequest {
-  InstanceId: string | undefined;
-  ContactId: string | undefined;
-  ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
-}
-export interface UpdateParticipantRoleConfigResponse {}
-export interface UpdatePhoneNumberRequest {
-  PhoneNumberId: string | undefined;
-  TargetArn?: string | undefined;
-  InstanceId?: string | undefined;
-  ClientToken?: string | undefined;
-}
 export declare const ViewSummaryFilterSensitiveLog: (obj: ViewSummary) => any;
 export declare const ListViewsResponseFilterSensitiveLog: (
   obj: ListViewsResponse

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

@@ -39,6 +39,7 @@ import {
 import {
   AnsweringMachineDetectionStatus,
   AttributeCondition,
+  ChatMetrics,
   ContactDetails,
   ContactEvaluation,
   ContactFlowModuleState,
@@ -83,9 +84,22 @@ import {
   RoutingProfileSearchFilter,
   SearchableQueueType,
   SecurityProfilesSearchFilter,
+  UpdateParticipantRoleConfigChannelInfo,
   UserHierarchyGroupSearchFilter,
   UserSearchFilter,
 } from "./models_2";
+export interface UpdateParticipantRoleConfigRequest {
+  InstanceId: string | undefined;
+  ContactId: string | undefined;
+  ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
+}
+export interface UpdateParticipantRoleConfigResponse {}
+export interface UpdatePhoneNumberRequest {
+  PhoneNumberId: string | undefined;
+  TargetArn?: string | undefined;
+  InstanceId?: string | undefined;
+  ClientToken?: string | undefined;
+}
 export interface UpdatePhoneNumberResponse {
   PhoneNumberId?: string | undefined;
   PhoneNumberArn?: string | undefined;
@@ -715,6 +729,7 @@ export interface Contact {
   AnsweringMachineDetectionStatus?: AnsweringMachineDetectionStatus | undefined;
   CustomerVoiceActivity?: CustomerVoiceActivity | undefined;
   QualityMetrics?: QualityMetrics | undefined;
+  ChatMetrics?: ChatMetrics | undefined;
   DisconnectDetails?: DisconnectDetails | undefined;
   AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined;
   SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-connect",
   "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
-  "version": "3.835.0",
+  "version": "3.840.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-connect",
@@ -20,38 +20,38 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "3.835.0",
-    "@aws-sdk/credential-provider-node": "3.835.0",
-    "@aws-sdk/middleware-host-header": "3.821.0",
-    "@aws-sdk/middleware-logger": "3.821.0",
-    "@aws-sdk/middleware-recursion-detection": "3.821.0",
-    "@aws-sdk/middleware-user-agent": "3.835.0",
-    "@aws-sdk/region-config-resolver": "3.821.0",
-    "@aws-sdk/types": "3.821.0",
-    "@aws-sdk/util-endpoints": "3.828.0",
-    "@aws-sdk/util-user-agent-browser": "3.821.0",
-    "@aws-sdk/util-user-agent-node": "3.835.0",
+    "@aws-sdk/core": "3.840.0",
+    "@aws-sdk/credential-provider-node": "3.840.0",
+    "@aws-sdk/middleware-host-header": "3.840.0",
+    "@aws-sdk/middleware-logger": "3.840.0",
+    "@aws-sdk/middleware-recursion-detection": "3.840.0",
+    "@aws-sdk/middleware-user-agent": "3.840.0",
+    "@aws-sdk/region-config-resolver": "3.840.0",
+    "@aws-sdk/types": "3.840.0",
+    "@aws-sdk/util-endpoints": "3.840.0",
+    "@aws-sdk/util-user-agent-browser": "3.840.0",
+    "@aws-sdk/util-user-agent-node": "3.840.0",
     "@smithy/config-resolver": "^4.1.4",
-    "@smithy/core": "^3.5.3",
+    "@smithy/core": "^3.6.0",
     "@smithy/fetch-http-handler": "^5.0.4",
     "@smithy/hash-node": "^4.0.4",
     "@smithy/invalid-dependency": "^4.0.4",
     "@smithy/middleware-content-length": "^4.0.4",
-    "@smithy/middleware-endpoint": "^4.1.12",
-    "@smithy/middleware-retry": "^4.1.13",
+    "@smithy/middleware-endpoint": "^4.1.13",
+    "@smithy/middleware-retry": "^4.1.14",
     "@smithy/middleware-serde": "^4.0.8",
     "@smithy/middleware-stack": "^4.0.4",
     "@smithy/node-config-provider": "^4.1.3",
     "@smithy/node-http-handler": "^4.0.6",
     "@smithy/protocol-http": "^5.1.2",
-    "@smithy/smithy-client": "^4.4.4",
+    "@smithy/smithy-client": "^4.4.5",
     "@smithy/types": "^4.3.1",
     "@smithy/url-parser": "^4.0.4",
     "@smithy/util-base64": "^4.0.0",
     "@smithy/util-body-length-browser": "^4.0.0",
     "@smithy/util-body-length-node": "^4.0.0",
-    "@smithy/util-defaults-mode-browser": "^4.0.20",
-    "@smithy/util-defaults-mode-node": "^4.0.20",
+    "@smithy/util-defaults-mode-browser": "^4.0.21",
+    "@smithy/util-defaults-mode-node": "^4.0.21",
     "@smithy/util-endpoints": "^3.0.6",
     "@smithy/util-middleware": "^4.0.4",
     "@smithy/util-retry": "^4.0.6",