@aws-sdk/client-connect 3.1155.0 → 3.1157.0

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

@@ -1,7 +1,123 @@
-import type { AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, AutoEvaluationStatus, Behavior, BooleanComparisonType, Channel, ChatEventType, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, EmailHeaderType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MeetingFeatureStatus, MetricUnit, MonitorCapability, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SecurityProfileType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TestCaseExecutionStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
-import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentHierarchyGroups, AgentStatus, AiAgentInput, AiAgentsCriteria, AliasConfiguration, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InputPredefinedAttributeConfiguration, InstanceStorageConfig, MetricCalculation, OutboundStrategy, PredefinedAttributeValues, PreEvaluationFilters, PrimaryValue, RecurrenceConfig, Reference, RuleTriggerEventSource, StringCondition, TagCondition, Validation } from "./models_0";
+import type { AgentStatusState, AiUseCase, AnalyticsMode, AttachmentScope, AutoEvaluationStatus, Behavior, BooleanComparisonType, Channel, ChatEventType, ContactEvaluationAttributeComparisonType, ContactEvaluationAttributeKey, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactMediaProcessingFailureMode, ContactParticipantRole, ContactRecordingType, DataTableAttributeValueType, DataTableLockLevel, DateComparisonType, DateTimeComparisonType, DecimalComparisonType, EmailHeaderType, EvaluationFormLanguageCode, EvaluationFormVersionStatus, EvaluationStatus, EvaluationType, FileStatusType, FileUseCaseType, HierarchyGroupMatchType, InboundMessageSourceType, InstanceAttributeType, InstanceStorageResourceType, IvrRecordingTrack, LocaleCode, MaskMode, MediaType, MeetingFeatureStatus, MetricUnit, MonitorCapability, NotificationPriority, NotificationType, NumberComparisonType, OutboundMessageSourceType, OverrideType, ParticipantRole, ParticipantTimerAction, ParticipantTimerType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, Policy, RehydrationType, ResponseMode, RuleCapabilityTier, RulePublishStatus, SearchContactsMatchType, SearchContactsTimeRangeConditionType, SearchContactsTimeRangeType, SecurityProfileType, SortableFieldName, SortOrder, StringComparisonType, SummaryMode, TargetListType, TestCaseExecutionStatus, TimerEligibleParticipantRoles, TrafficType, TrendIndicator, UpdateOutboundEmailMessageSourceType, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, VoiceRecordingTrack } from "./enums";
+import type { ActionSummary, AfterContactWorkConfigPerChannel, AgentHierarchyGroups, AgentStatus, AiAgentInput, AiAgentsCriteria, AliasConfiguration, ControlPlaneAttributeFilter, CreatedByInfo, DataTableLockVersion, ExtractionConfiguration, ExtractionDefinitionDisplay, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, MetricCalculation, OutboundStrategy, PreEvaluationFilters, PrimaryValue, RecurrenceConfig, Reference, RuleTriggerEventSource, StringCondition, TagCondition, Validation } from "./models_0";
 import type { AutoAcceptConfig, ContactFlow, ContactFlowModule, DataTable, EvaluationAnswerData, EvaluationNote, ExtensionConfiguration, HierarchyGroup, HoursOfOperation, HoursOfOperationOverride, MetricDefinition, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, TestCase, UserPhoneConfig, View, VoiceEnhancementConfig } from "./models_1";
-import type { MediaItem } from "./models_2";
+/**
+ * @public
+ */
+export interface ListViewVersionsRequest {
+    /**
+     * <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
+     *    instance.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be used.</p>
+     * @public
+     */
+    ViewId: string | undefined;
+    /**
+     * <p>The token for the next set of results. Use the value returned in the previous response in the next request to
+     *    retrieve the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+}
+/**
+ * <p>A summary of a view version's metadata.</p>
+ * @public
+ */
+export interface ViewVersionSummary {
+    /**
+     * <p>The identifier of the view version.</p>
+     * @public
+     */
+    Id?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the view version.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+    /**
+     * <p>The description of the view version.</p>
+     * @public
+     */
+    Description?: string | undefined;
+    /**
+     * <p>The name of the view version.</p>
+     * @public
+     */
+    Name?: string | undefined;
+    /**
+     * <p>The type of the view version.</p>
+     * @public
+     */
+    Type?: ViewType | undefined;
+    /**
+     * <p>The sequentially incremented version of the view version.</p>
+     * @public
+     */
+    Version?: number | undefined;
+    /**
+     * <p>The description of the view version.</p>
+     * @public
+     */
+    VersionDescription?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListViewVersionsResponse {
+    /**
+     * <p>A list of view version summaries.</p>
+     * @public
+     */
+    ViewVersionSummaryList?: ViewVersionSummary[] | undefined;
+    /**
+     * <p>The token for the next set of results. Use the value returned in the previous response in the next request to
+     *    retrieve the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListWorkspaceMediaRequest {
+    /**
+     * <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 workspace.</p>
+     * @public
+     */
+    WorkspaceId: string | undefined;
+}
+/**
+ * <p>Contains information about a media asset used in a workspace.</p>
+ * @public
+ */
+export interface MediaItem {
+    /**
+     * <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and
+     *    <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
+     * @public
+     */
+    Type?: MediaType | undefined;
+    /**
+     * <p>The source URL or data for the media asset.</p>
+     * @public
+     */
+    Source?: string | undefined;
+}
 /**
  * @public
  */
@@ -5420,6 +5536,18 @@ export interface UpdateAuthenticationProfileRequest {
      */
     SessionInactivityHandlingEnabled?: boolean | undefined;
 }
+/**
+ * Additional recipients for UpdateContact, allowing an empty list to clear CC recipients.
+ * @public
+ */
+export interface NullableAdditionalRecipients {
+    /**
+     * <p>The additional CC email address recipients. You can specify up to 50 addresses. Provide an empty list to clear
+     *    the existing CC recipients.</p>
+     * @public
+     */
+    CcEmailAddresses?: EmailAddressInfo[] | undefined;
+}
 /**
  * <p>Information about a queue.</p>
  * @public
@@ -6378,6 +6506,78 @@ export interface UpdateNotificationContentRequest {
  */
 export interface UpdateNotificationContentResponse {
 }
+/**
+ * <p>Contains the raw body content of an outbound email draft.</p>
+ * @public
+ */
+export interface UpdateOutboundRawMessage {
+    /**
+     * <p>The email message body.</p>
+     * @public
+     */
+    Body: string | undefined;
+    /**
+     * <p>The content type of the email body. Valid values:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>text/plain</code> – Plain text content.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>text/html</code> – HTML-formatted content.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    ContentType: string | undefined;
+}
+/**
+ * <p>Contains the updated body content for an outbound email draft.</p>
+ * @public
+ */
+export interface UpdateOutboundEmailContent {
+    /**
+     * <p>The message source type. The only supported value is <code>RAW</code>.</p>
+     * @public
+     */
+    MessageSourceType: UpdateOutboundEmailMessageSourceType | undefined;
+    /**
+     * <p>The raw email body content.</p>
+     * @public
+     */
+    RawMessage: UpdateOutboundRawMessage | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateOutboundEmailContactMessageRequest {
+    /**
+     * <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 identifier of the contact in this instance of Connect Customer. </p>
+     * @public
+     */
+    ContactId: string | undefined;
+    /**
+     * <p>The email message body to update on the outbound email draft.</p>
+     * @public
+     */
+    EmailMessage: UpdateOutboundEmailContent | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateOutboundEmailContactMessageResponse {
+    /**
+     * <p>The identifier of the contact in this instance of Connect Customer. </p>
+     * @public
+     */
+    ContactId: string | undefined;
+}
 /**
  * @public
  */
@@ -6555,221 +6755,3 @@ export interface UpdateParticipantRoleConfigRequest {
      */
     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 Connect Customer 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 Connect Customer 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
- */
-export interface UpdatePhoneNumberResponse {
-    /**
-     * <p>A unique identifier for the phone number.</p>
-     * @public
-     */
-    PhoneNumberId?: string | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the phone number.</p>
-     * @public
-     */
-    PhoneNumberArn?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdatePhoneNumberMetadataRequest {
-    /**
-     * <p>The Amazon Resource Name (ARN) or resource ID of the phone number.</p>
-     * @public
-     */
-    PhoneNumberId: string | undefined;
-    /**
-     * <p>The description of the phone number.</p>
-     * @public
-     */
-    PhoneNumberDescription?: 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
- */
-export interface UpdatePredefinedAttributeRequest {
-    /**
-     * <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the
-     *    instance.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The name of the predefined attribute.</p>
-     * @public
-     */
-    Name: string | undefined;
-    /**
-     * <p>The values of the predefined attribute.</p>
-     * @public
-     */
-    Values?: PredefinedAttributeValues | undefined;
-    /**
-     * <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.</p>
-     * @public
-     */
-    Purposes?: string[] | undefined;
-    /**
-     * <p>Custom metadata that is associated to predefined attributes to control behavior
-     * in upstream services, such as controlling
-     * how a predefined attribute should be displayed in the Connect Customer admin website.</p>
-     * @public
-     */
-    AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined;
-}
-/**
- * @public
- */
-export interface UpdatePromptRequest {
-    /**
-     * <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>A unique identifier for the prompt.</p>
-     * @public
-     */
-    PromptId: string | undefined;
-    /**
-     * <p>The name of the prompt.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>A description of the prompt.</p>
-     * @public
-     */
-    Description?: string | undefined;
-    /**
-     * <p>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the
-     * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a>
-     *  API instead of providing S3 URIs.</p>
-     * @public
-     */
-    S3Uri?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdatePromptResponse {
-    /**
-     * <p>The Amazon Resource Name (ARN) of the prompt.</p>
-     * @public
-     */
-    PromptARN?: string | undefined;
-    /**
-     * <p>A unique identifier for the prompt.</p>
-     * @public
-     */
-    PromptId?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQueueHoursOfOperationRequest {
-    /**
-     * <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 identifier for the queue.</p>
-     * @public
-     */
-    QueueId: string | undefined;
-    /**
-     * <p>The identifier for the hours of operation.</p>
-     * @public
-     */
-    HoursOfOperationId: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQueueMaxContactsRequest {
-    /**
-     * <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 identifier for the queue.</p>
-     * @public
-     */
-    QueueId: string | undefined;
-    /**
-     * <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
-     * @public
-     */
-    MaxContacts?: number | undefined;
-}
-/**
- * @public
- */
-export interface UpdateQueueNameRequest {
-    /**
-     * <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 identifier for the queue.</p>
-     * @public
-     */
-    QueueId: string | undefined;
-    /**
-     * <p>The name of the queue.</p>
-     * @public
-     */
-    Name?: string | undefined;
-    /**
-     * <p>The description of the queue.</p>
-     * @public
-     */
-    Description?: string | undefined;
-}