@aws-sdk/client-connect 3.319.0 → 3.321.1

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

@@ -2,15 +2,30 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-cl
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
 import {
   ActionSummary,
+  AgentContactReference,
+  AgentStatusReference,
   AgentStatusState,
   AgentStatusSummary,
+  AgentStatusType,
   Attribute,
   Channel,
+  ContactFilter,
   ContactFlowModuleState,
   ContactFlowState,
   ContactFlowType,
+  Dimensions,
   DirectoryType,
+  Evaluation,
+  EvaluationAnswerData,
+  EvaluationFormQuestion,
+  EvaluationFormScoringStrategy,
+  EvaluationFormVersionStatus,
+  EvaluationNote,
+  EvaluationScore,
+  EvaluationStatus,
   EventSourceName,
+  Filters,
+  Grouping,
   HierarchyGroupSummary,
   HoursOfOperationConfig,
   InstanceAttributeType,
@@ -33,6 +48,7 @@ import {
   ReferenceType,
   RoutingProfile,
   RoutingProfileQueueConfig,
+  RoutingProfileReference,
   RuleAction,
   RulePublishStatus,
   SourceType,
@@ -40,14 +56,232 @@ import {
   TaskTemplateDefaults,
   TaskTemplateField,
   TaskTemplateStatus,
-  TelephonyConfig,
   TrafficDistributionGroupStatus,
+  Unit,
   UseCaseType,
   UserIdentityInfo,
   UserPhoneConfig,
   VocabularyLanguageCode,
   VocabularyState,
 } from "./models_0";
+export interface UserDataFilters {
+  Queues?: string[];
+  ContactFilter?: ContactFilter;
+  RoutingProfiles?: string[];
+  Agents?: string[];
+  UserHierarchyGroups?: string[];
+}
+export interface GetCurrentUserDataRequest {
+  InstanceId: string | undefined;
+  Filters: UserDataFilters | undefined;
+  NextToken?: string;
+  MaxResults?: number;
+}
+export interface HierarchyGroupSummaryReference {
+  Id?: string;
+  Arn?: string;
+}
+export interface HierarchyPathReference {
+  LevelOne?: HierarchyGroupSummaryReference;
+  LevelTwo?: HierarchyGroupSummaryReference;
+  LevelThree?: HierarchyGroupSummaryReference;
+  LevelFour?: HierarchyGroupSummaryReference;
+  LevelFive?: HierarchyGroupSummaryReference;
+}
+export interface UserReference {
+  Id?: string;
+  Arn?: string;
+}
+export interface UserData {
+  User?: UserReference;
+  RoutingProfile?: RoutingProfileReference;
+  HierarchyPath?: HierarchyPathReference;
+  Status?: AgentStatusReference;
+  AvailableSlotsByChannel?: Record<string, number>;
+  MaxSlotsByChannel?: Record<string, number>;
+  ActiveSlotsByChannel?: Record<string, number>;
+  Contacts?: AgentContactReference[];
+  NextStatus?: string;
+}
+export interface GetCurrentUserDataResponse {
+  NextToken?: string;
+  UserDataList?: UserData[];
+  ApproximateTotalCount?: number;
+}
+export interface GetFederationTokenRequest {
+  InstanceId: string | undefined;
+}
+export interface Credentials {
+  AccessToken?: string;
+  AccessTokenExpiration?: Date;
+  RefreshToken?: string;
+  RefreshTokenExpiration?: Date;
+}
+export interface GetFederationTokenResponse {
+  Credentials?: Credentials;
+  SignInUrl?: string;
+  UserArn?: string;
+  UserId?: string;
+}
+export declare class UserNotFoundException extends __BaseException {
+  readonly name: "UserNotFoundException";
+  readonly $fault: "client";
+  Message?: string;
+  constructor(
+    opts: __ExceptionOptionType<UserNotFoundException, __BaseException>
+  );
+}
+export declare const HistoricalMetricName: {
+  readonly ABANDON_TIME: "ABANDON_TIME";
+  readonly AFTER_CONTACT_WORK_TIME: "AFTER_CONTACT_WORK_TIME";
+  readonly API_CONTACTS_HANDLED: "API_CONTACTS_HANDLED";
+  readonly CALLBACK_CONTACTS_HANDLED: "CALLBACK_CONTACTS_HANDLED";
+  readonly CONTACTS_ABANDONED: "CONTACTS_ABANDONED";
+  readonly CONTACTS_AGENT_HUNG_UP_FIRST: "CONTACTS_AGENT_HUNG_UP_FIRST";
+  readonly CONTACTS_CONSULTED: "CONTACTS_CONSULTED";
+  readonly CONTACTS_HANDLED: "CONTACTS_HANDLED";
+  readonly CONTACTS_HANDLED_INCOMING: "CONTACTS_HANDLED_INCOMING";
+  readonly CONTACTS_HANDLED_OUTBOUND: "CONTACTS_HANDLED_OUTBOUND";
+  readonly CONTACTS_HOLD_ABANDONS: "CONTACTS_HOLD_ABANDONS";
+  readonly CONTACTS_MISSED: "CONTACTS_MISSED";
+  readonly CONTACTS_QUEUED: "CONTACTS_QUEUED";
+  readonly CONTACTS_TRANSFERRED_IN: "CONTACTS_TRANSFERRED_IN";
+  readonly CONTACTS_TRANSFERRED_IN_FROM_QUEUE: "CONTACTS_TRANSFERRED_IN_FROM_QUEUE";
+  readonly CONTACTS_TRANSFERRED_OUT: "CONTACTS_TRANSFERRED_OUT";
+  readonly CONTACTS_TRANSFERRED_OUT_FROM_QUEUE: "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE";
+  readonly HANDLE_TIME: "HANDLE_TIME";
+  readonly HOLD_TIME: "HOLD_TIME";
+  readonly INTERACTION_AND_HOLD_TIME: "INTERACTION_AND_HOLD_TIME";
+  readonly INTERACTION_TIME: "INTERACTION_TIME";
+  readonly OCCUPANCY: "OCCUPANCY";
+  readonly QUEUED_TIME: "QUEUED_TIME";
+  readonly QUEUE_ANSWER_TIME: "QUEUE_ANSWER_TIME";
+  readonly SERVICE_LEVEL: "SERVICE_LEVEL";
+};
+export type HistoricalMetricName =
+  (typeof HistoricalMetricName)[keyof typeof HistoricalMetricName];
+export declare const Statistic: {
+  readonly AVG: "AVG";
+  readonly MAX: "MAX";
+  readonly SUM: "SUM";
+};
+export type Statistic = (typeof Statistic)[keyof typeof Statistic];
+export declare const Comparison: {
+  readonly LT: "LT";
+};
+export type Comparison = (typeof Comparison)[keyof typeof Comparison];
+export interface Threshold {
+  Comparison?: Comparison | string;
+  ThresholdValue?: number;
+}
+export interface HistoricalMetric {
+  Name?: HistoricalMetricName | string;
+  Threshold?: Threshold;
+  Statistic?: Statistic | string;
+  Unit?: Unit | string;
+}
+export interface GetMetricDataRequest {
+  InstanceId: string | undefined;
+  StartTime: Date | undefined;
+  EndTime: Date | undefined;
+  Filters: Filters | undefined;
+  Groupings?: (Grouping | string)[];
+  HistoricalMetrics: HistoricalMetric[] | undefined;
+  NextToken?: string;
+  MaxResults?: number;
+}
+export interface HistoricalMetricData {
+  Metric?: HistoricalMetric;
+  Value?: number;
+}
+export interface HistoricalMetricResult {
+  Dimensions?: Dimensions;
+  Collections?: HistoricalMetricData[];
+}
+export interface GetMetricDataResponse {
+  NextToken?: string;
+  MetricResults?: HistoricalMetricResult[];
+}
+export interface FilterV2 {
+  FilterKey?: string;
+  FilterValues?: string[];
+}
+export interface MetricFilterV2 {
+  MetricFilterKey?: string;
+  MetricFilterValues?: string[];
+}
+export interface ThresholdV2 {
+  Comparison?: string;
+  ThresholdValue?: number;
+}
+export interface MetricV2 {
+  Name?: string;
+  Threshold?: ThresholdV2[];
+  MetricFilters?: MetricFilterV2[];
+}
+export interface GetMetricDataV2Request {
+  ResourceArn: string | undefined;
+  StartTime: Date | undefined;
+  EndTime: Date | undefined;
+  Filters: FilterV2[] | undefined;
+  Groupings?: string[];
+  Metrics: MetricV2[] | undefined;
+  NextToken?: string;
+  MaxResults?: number;
+}
+export interface MetricDataV2 {
+  Metric?: MetricV2;
+  Value?: number;
+}
+export interface MetricResultV2 {
+  Dimensions?: Record<string, string>;
+  Collections?: MetricDataV2[];
+}
+export interface GetMetricDataV2Response {
+  NextToken?: string;
+  MetricResults?: MetricResultV2[];
+}
+export interface GetTaskTemplateRequest {
+  InstanceId: string | undefined;
+  TaskTemplateId: string | undefined;
+  SnapshotVersion?: string;
+}
+export interface GetTaskTemplateResponse {
+  InstanceId?: string;
+  Id: string | undefined;
+  Arn: string | undefined;
+  Name: string | undefined;
+  Description?: string;
+  ContactFlowId?: string;
+  Constraints?: TaskTemplateConstraints;
+  Defaults?: TaskTemplateDefaults;
+  Fields?: TaskTemplateField[];
+  Status?: TaskTemplateStatus | string;
+  LastModifiedTime?: Date;
+  CreatedTime?: Date;
+  Tags?: Record<string, string>;
+}
+export interface GetTrafficDistributionRequest {
+  Id: string | undefined;
+}
+export interface Distribution {
+  Region: string | undefined;
+  Percentage: number | undefined;
+}
+export interface TelephonyConfig {
+  Distributions: Distribution[] | undefined;
+}
+export interface GetTrafficDistributionResponse {
+  TelephonyConfig?: TelephonyConfig;
+  Id?: string;
+  Arn?: string;
+}
+export interface ListAgentStatusRequest {
+  InstanceId: string | undefined;
+  NextToken?: string;
+  MaxResults?: number;
+  AgentStatusTypes?: (AgentStatusType | string)[];
+}
 export interface ListAgentStatusResponse {
   NextToken?: string;
   AgentStatusSummaryList?: AgentStatusSummary[];
@@ -80,6 +314,26 @@ export interface ListBotsResponse {
   LexBots?: LexBotConfig[];
   NextToken?: string;
 }
+export interface ListContactEvaluationsRequest {
+  InstanceId: string | undefined;
+  ContactId: string | undefined;
+  NextToken?: string;
+}
+export interface EvaluationSummary {
+  EvaluationId: string | undefined;
+  EvaluationArn: string | undefined;
+  EvaluationFormTitle: string | undefined;
+  EvaluationFormId: string | undefined;
+  Status: EvaluationStatus | string | undefined;
+  EvaluatorArn: string | undefined;
+  Score?: EvaluationScore;
+  CreatedTime: Date | undefined;
+  LastModifiedTime: Date | undefined;
+}
+export interface ListContactEvaluationsResponse {
+  EvaluationSummaryList: EvaluationSummary[] | undefined;
+  NextToken?: string;
+}
 export interface ListContactFlowModulesRequest {
   InstanceId: string | undefined;
   NextToken?: string;
@@ -253,6 +507,49 @@ export interface ListDefaultVocabulariesResponse {
   DefaultVocabularyList: DefaultVocabulary[] | undefined;
   NextToken?: string;
 }
+export interface ListEvaluationFormsRequest {
+  InstanceId: string | undefined;
+  MaxResults?: number;
+  NextToken?: string;
+}
+export interface EvaluationFormSummary {
+  EvaluationFormId: string | undefined;
+  EvaluationFormArn: string | undefined;
+  Title: string | undefined;
+  CreatedTime: Date | undefined;
+  CreatedBy: string | undefined;
+  LastModifiedTime: Date | undefined;
+  LastModifiedBy: string | undefined;
+  LastActivatedTime?: Date;
+  LastActivatedBy?: string;
+  LatestVersion: number | undefined;
+  ActiveVersion?: number;
+}
+export interface ListEvaluationFormsResponse {
+  EvaluationFormSummaryList: EvaluationFormSummary[] | undefined;
+  NextToken?: string;
+}
+export interface ListEvaluationFormVersionsRequest {
+  InstanceId: string | undefined;
+  EvaluationFormId: string | undefined;
+  MaxResults?: number;
+  NextToken?: string;
+}
+export interface EvaluationFormVersionSummary {
+  EvaluationFormArn: string | undefined;
+  EvaluationFormId: string | undefined;
+  EvaluationFormVersion: number | undefined;
+  Locked: boolean | undefined;
+  Status: EvaluationFormVersionStatus | string | undefined;
+  CreatedTime: Date | undefined;
+  CreatedBy: string | undefined;
+  LastModifiedTime: Date | undefined;
+  LastModifiedBy: string | undefined;
+}
+export interface ListEvaluationFormVersionsResponse {
+  EvaluationFormVersionSummaryList: EvaluationFormVersionSummary[] | undefined;
+  NextToken?: string;
+}
 export interface ListHoursOfOperationsRequest {
   InstanceId: string | undefined;
   NextToken?: string;
@@ -815,6 +1112,16 @@ export interface StartChatContactResponse {
   ParticipantToken?: string;
   ContinuedFromContactId?: string;
 }
+export interface StartContactEvaluationRequest {
+  InstanceId: string | undefined;
+  ContactId: string | undefined;
+  EvaluationFormId: string | undefined;
+  ClientToken?: string;
+}
+export interface StartContactEvaluationResponse {
+  EvaluationId: string | undefined;
+  EvaluationArn: string | undefined;
+}
 export declare const VoiceRecordingTrack: {
   readonly ALL: "ALL";
   readonly FROM_AGENT: "FROM_AGENT";
@@ -929,6 +1236,19 @@ export interface StopContactStreamingRequest {
   StreamingId: string | undefined;
 }
 export interface StopContactStreamingResponse {}
+export interface EvaluationAnswerInput {
+  Value?: EvaluationAnswerData;
+}
+export interface SubmitContactEvaluationRequest {
+  InstanceId: string | undefined;
+  EvaluationId: string | undefined;
+  Answers?: Record<string, EvaluationAnswerInput>;
+  Notes?: Record<string, EvaluationNote>;
+}
+export interface SubmitContactEvaluationResponse {
+  EvaluationId: string | undefined;
+  EvaluationArn: string | undefined;
+}
 export interface SuspendContactRecordingRequest {
   InstanceId: string | undefined;
   ContactId: string | undefined;
@@ -978,6 +1298,16 @@ export interface UpdateContactAttributesRequest {
   Attributes: Record<string, string> | undefined;
 }
 export interface UpdateContactAttributesResponse {}
+export interface UpdateContactEvaluationRequest {
+  InstanceId: string | undefined;
+  EvaluationId: string | undefined;
+  Answers?: Record<string, EvaluationAnswerInput>;
+  Notes?: Record<string, EvaluationNote>;
+}
+export interface UpdateContactEvaluationResponse {
+  EvaluationId: string | undefined;
+  EvaluationArn: string | undefined;
+}
 export interface UpdateContactFlowContentRequest {
   InstanceId: string | undefined;
   ContactFlowId: string | undefined;
@@ -1019,6 +1349,11 @@ export interface UpdateContactScheduleRequest {
   ScheduledTime: Date | undefined;
 }
 export interface UpdateContactScheduleResponse {}
+export interface UpdateEvaluationFormResponse {
+  EvaluationFormId: string | undefined;
+  EvaluationFormArn: string | undefined;
+  EvaluationFormVersion: number | undefined;
+}
 export interface UpdateHoursOfOperationRequest {
   InstanceId: string | undefined;
   HoursOfOperationId: string | undefined;
@@ -1274,6 +1609,73 @@ export interface UpdateUserSecurityProfilesRequest {
   UserId: string | undefined;
   InstanceId: string | undefined;
 }
+export type EvaluationFormItem =
+  | EvaluationFormItem.QuestionMember
+  | EvaluationFormItem.SectionMember
+  | EvaluationFormItem.$UnknownMember;
+export declare namespace EvaluationFormItem {
+  interface SectionMember {
+    Section: EvaluationFormSection;
+    Question?: never;
+    $unknown?: never;
+  }
+  interface QuestionMember {
+    Section?: never;
+    Question: EvaluationFormQuestion;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    Section?: never;
+    Question?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    Section: (value: EvaluationFormSection) => T;
+    Question: (value: EvaluationFormQuestion) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: EvaluationFormItem, visitor: Visitor<T>) => T;
+}
+export interface EvaluationFormSection {
+  Title: string | undefined;
+  RefId: string | undefined;
+  Instructions?: string;
+  Items?: EvaluationFormItem[];
+  Weight?: number;
+}
+export interface CreateEvaluationFormRequest {
+  InstanceId: string | undefined;
+  Title: string | undefined;
+  Description?: string;
+  Items: EvaluationFormItem[] | undefined;
+  ScoringStrategy?: EvaluationFormScoringStrategy;
+  ClientToken?: string;
+}
+export interface EvaluationForm {
+  EvaluationFormId: string | undefined;
+  EvaluationFormVersion: number | undefined;
+  Locked: boolean | undefined;
+  EvaluationFormArn: string | undefined;
+  Title: string | undefined;
+  Description?: string;
+  Status: EvaluationFormVersionStatus | string | undefined;
+  Items: EvaluationFormItem[] | undefined;
+  ScoringStrategy?: EvaluationFormScoringStrategy;
+  CreatedTime: Date | undefined;
+  CreatedBy: string | undefined;
+  LastModifiedTime: Date | undefined;
+  LastModifiedBy: string | undefined;
+  Tags?: Record<string, string>;
+}
+export interface EvaluationFormContent {
+  EvaluationFormVersion: number | undefined;
+  EvaluationFormId: string | undefined;
+  EvaluationFormArn: string | undefined;
+  Title: string | undefined;
+  Description?: string;
+  Items: EvaluationFormItem[] | undefined;
+  ScoringStrategy?: EvaluationFormScoringStrategy;
+}
 export interface QueueSearchCriteria {
   OrConditions?: QueueSearchCriteria[];
   AndConditions?: QueueSearchCriteria[];
@@ -1290,12 +1692,30 @@ export interface SecurityProfileSearchCriteria {
   AndConditions?: SecurityProfileSearchCriteria[];
   StringCondition?: StringCondition;
 }
+export interface UpdateEvaluationFormRequest {
+  InstanceId: string | undefined;
+  EvaluationFormId: string | undefined;
+  EvaluationFormVersion: number | undefined;
+  CreateNewVersion?: boolean;
+  Title: string | undefined;
+  Description?: string;
+  Items: EvaluationFormItem[] | undefined;
+  ScoringStrategy?: EvaluationFormScoringStrategy;
+  ClientToken?: string;
+}
 export interface UserSearchCriteria {
   OrConditions?: UserSearchCriteria[];
   AndConditions?: UserSearchCriteria[];
   StringCondition?: StringCondition;
   HierarchyGroupCondition?: HierarchyGroupCondition;
 }
+export interface DescribeContactEvaluationResponse {
+  Evaluation: Evaluation | undefined;
+  EvaluationForm: EvaluationFormContent | undefined;
+}
+export interface DescribeEvaluationFormResponse {
+  EvaluationForm: EvaluationForm | undefined;
+}
 export interface SearchQueuesRequest {
   InstanceId: string | undefined;
   NextToken?: string;
@@ -1324,6 +1744,10 @@ export interface SearchUsersRequest {
   SearchFilter?: UserSearchFilter;
   SearchCriteria?: UserSearchCriteria;
 }
+export declare const CredentialsFilterSensitiveLog: (obj: Credentials) => any;
+export declare const GetFederationTokenResponseFilterSensitiveLog: (
+  obj: GetFederationTokenResponse
+) => any;
 export declare const InstanceSummaryFilterSensitiveLog: (
   obj: InstanceSummary
 ) => any;

package/dist-types/ts3.4/pagination/ListContactEvaluationsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListContactEvaluationsCommandInput,
+  ListContactEvaluationsCommandOutput,
+} from "../commands/ListContactEvaluationsCommand";
+import { ConnectPaginationConfiguration } from "./Interfaces";
+export declare function paginateListContactEvaluations(
+  config: ConnectPaginationConfiguration,
+  input: ListContactEvaluationsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListContactEvaluationsCommandOutput>;

package/dist-types/ts3.4/pagination/ListEvaluationFormVersionsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListEvaluationFormVersionsCommandInput,
+  ListEvaluationFormVersionsCommandOutput,
+} from "../commands/ListEvaluationFormVersionsCommand";
+import { ConnectPaginationConfiguration } from "./Interfaces";
+export declare function paginateListEvaluationFormVersions(
+  config: ConnectPaginationConfiguration,
+  input: ListEvaluationFormVersionsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListEvaluationFormVersionsCommandOutput>;

package/dist-types/ts3.4/pagination/ListEvaluationFormsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@aws-sdk/types";
+import {
+  ListEvaluationFormsCommandInput,
+  ListEvaluationFormsCommandOutput,
+} from "../commands/ListEvaluationFormsCommand";
+import { ConnectPaginationConfiguration } from "./Interfaces";
+export declare function paginateListEvaluationForms(
+  config: ConnectPaginationConfiguration,
+  input: ListEvaluationFormsCommandInput,
+  ...additionalArguments: any
+): Paginator<ListEvaluationFormsCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -6,10 +6,13 @@ export * from "./Interfaces";
 export * from "./ListAgentStatusesPaginator";
 export * from "./ListApprovedOriginsPaginator";
 export * from "./ListBotsPaginator";
+export * from "./ListContactEvaluationsPaginator";
 export * from "./ListContactFlowModulesPaginator";
 export * from "./ListContactFlowsPaginator";
 export * from "./ListContactReferencesPaginator";
 export * from "./ListDefaultVocabulariesPaginator";
+export * from "./ListEvaluationFormVersionsPaginator";
+export * from "./ListEvaluationFormsPaginator";
 export * from "./ListHoursOfOperationsPaginator";
 export * from "./ListInstanceAttributesPaginator";
 export * from "./ListInstanceStorageConfigsPaginator";