@aws-sdk/client-connect 3.985.0 → 3.987.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -0
- package/dist-cjs/index.js +122 -22
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/UpdateUserConfigCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +11 -6
- package/dist-es/schemas/schemas_0.js +88 -16
- package/dist-types/Connect.d.ts +7 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/CreateUserCommand.d.ts +64 -1
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +38 -1
- package/dist-types/commands/ListAgentStatusesCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalyticsDataAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +1 -2
- package/dist-types/commands/SearchUsersCommand.d.ts +38 -1
- package/dist-types/commands/SearchWorkspaceAssociationsCommand.d.ts +1 -2
- package/dist-types/commands/SearchWorkspacesCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserConfigCommand.d.ts +131 -0
- package/dist-types/commands/UpdateUserPhoneConfigCommand.d.ts +4 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +27 -14
- package/dist-types/models/models_0.d.ts +138 -115
- package/dist-types/models/models_1.d.ts +138 -124
- package/dist-types/models/models_2.d.ts +150 -166
- package/dist-types/models/models_3.d.ts +206 -3
- package/dist-types/schemas/schemas_0.d.ts +8 -0
- package/dist-types/ts3.4/Connect.d.ts +17 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAgentStatusesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAnalyticsDataAssociationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchWorkspaceAssociationsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchWorkspacesCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateUserConfigCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +14 -7
- package/dist-types/ts3.4/models/models_0.d.ts +34 -30
- package/dist-types/ts3.4/models/models_1.d.ts +40 -33
- package/dist-types/ts3.4/models/models_2.d.ts +42 -36
- package/dist-types/ts3.4/models/models_3.d.ts +50 -3
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +8 -0
- package/package.json +2 -2
|
@@ -154,7 +154,7 @@ declare const SearchUsersCommand_base: {
|
|
|
154
154
|
* // LastName: "STRING_VALUE",
|
|
155
155
|
* // },
|
|
156
156
|
* // PhoneConfig: { // UserPhoneConfig
|
|
157
|
-
* // PhoneType: "SOFT_PHONE" || "DESK_PHONE",
|
|
157
|
+
* // PhoneType: "SOFT_PHONE" || "DESK_PHONE",
|
|
158
158
|
* // AutoAccept: true || false,
|
|
159
159
|
* // AfterContactWorkTimeLimit: Number("int"),
|
|
160
160
|
* // DeskPhoneNumber: "STRING_VALUE",
|
|
@@ -168,6 +168,43 @@ declare const SearchUsersCommand_base: {
|
|
|
168
168
|
* // "<keys>": "STRING_VALUE",
|
|
169
169
|
* // },
|
|
170
170
|
* // Username: "STRING_VALUE",
|
|
171
|
+
* // AutoAcceptConfigs: [ // AutoAcceptConfigs
|
|
172
|
+
* // { // AutoAcceptConfig
|
|
173
|
+
* // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
174
|
+
* // AutoAccept: true || false, // required
|
|
175
|
+
* // AgentFirstCallbackAutoAccept: true || false,
|
|
176
|
+
* // },
|
|
177
|
+
* // ],
|
|
178
|
+
* // AfterContactWorkConfigs: [ // AfterContactWorkConfigs
|
|
179
|
+
* // { // AfterContactWorkConfigPerChannel
|
|
180
|
+
* // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
181
|
+
* // AfterContactWorkConfig: { // AfterContactWorkConfig
|
|
182
|
+
* // AfterContactWorkTimeLimit: Number("int"),
|
|
183
|
+
* // },
|
|
184
|
+
* // AgentFirstCallbackAfterContactWorkConfig: {
|
|
185
|
+
* // AfterContactWorkTimeLimit: Number("int"),
|
|
186
|
+
* // },
|
|
187
|
+
* // },
|
|
188
|
+
* // ],
|
|
189
|
+
* // PhoneNumberConfigs: [ // PhoneNumberConfigs
|
|
190
|
+
* // { // PhoneNumberConfig
|
|
191
|
+
* // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
192
|
+
* // PhoneType: "SOFT_PHONE" || "DESK_PHONE", // required
|
|
193
|
+
* // PhoneNumber: "STRING_VALUE",
|
|
194
|
+
* // },
|
|
195
|
+
* // ],
|
|
196
|
+
* // PersistentConnectionConfigs: [ // PersistentConnectionConfigs
|
|
197
|
+
* // { // PersistentConnectionConfig
|
|
198
|
+
* // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
199
|
+
* // PersistentConnection: true || false, // required
|
|
200
|
+
* // },
|
|
201
|
+
* // ],
|
|
202
|
+
* // VoiceEnhancementConfigs: [ // VoiceEnhancementConfigs
|
|
203
|
+
* // { // VoiceEnhancementConfig
|
|
204
|
+
* // Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
205
|
+
* // VoiceEnhancementMode: "VOICE_ISOLATION" || "NOISE_SUPPRESSION" || "NONE", // required
|
|
206
|
+
* // },
|
|
207
|
+
* // ],
|
|
171
208
|
* // },
|
|
172
209
|
* // ],
|
|
173
210
|
* // NextToken: "STRING_VALUE",
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import type { SearchWorkspaceAssociationsResponse } from "../models/
|
|
5
|
-
import type { SearchWorkspaceAssociationsRequest } from "../models/models_3";
|
|
4
|
+
import type { SearchWorkspaceAssociationsRequest, SearchWorkspaceAssociationsResponse } from "../models/models_3";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import type { SearchWorkspacesResponse } from "../models/
|
|
5
|
-
import type { SearchWorkspacesRequest } from "../models/models_3";
|
|
4
|
+
import type { SearchWorkspacesRequest, SearchWorkspacesResponse } from "../models/models_3";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import type { UpdateUserConfigRequest } from "../models/models_3";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateUserConfigCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateUserConfigCommandInput extends UpdateUserConfigRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateUserConfigCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateUserConfigCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateUserConfigCommand_base: {
|
|
25
|
+
new (input: UpdateUserConfigCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserConfigCommandInput, UpdateUserConfigCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateUserConfigCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserConfigCommandInput, UpdateUserConfigCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.</p>
|
|
33
|
+
* </note>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { ConnectClient, UpdateUserConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
38
|
+
* // const { ConnectClient, UpdateUserConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
39
|
+
* // import type { ConnectClientConfig } from "@aws-sdk/client-connect";
|
|
40
|
+
* const config = {}; // type is ConnectClientConfig
|
|
41
|
+
* const client = new ConnectClient(config);
|
|
42
|
+
* const input = { // UpdateUserConfigRequest
|
|
43
|
+
* AutoAcceptConfigs: [ // AutoAcceptConfigs
|
|
44
|
+
* { // AutoAcceptConfig
|
|
45
|
+
* Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
46
|
+
* AutoAccept: true || false, // required
|
|
47
|
+
* AgentFirstCallbackAutoAccept: true || false,
|
|
48
|
+
* },
|
|
49
|
+
* ],
|
|
50
|
+
* AfterContactWorkConfigs: [ // AfterContactWorkConfigs
|
|
51
|
+
* { // AfterContactWorkConfigPerChannel
|
|
52
|
+
* Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
53
|
+
* AfterContactWorkConfig: { // AfterContactWorkConfig
|
|
54
|
+
* AfterContactWorkTimeLimit: Number("int"),
|
|
55
|
+
* },
|
|
56
|
+
* AgentFirstCallbackAfterContactWorkConfig: {
|
|
57
|
+
* AfterContactWorkTimeLimit: Number("int"),
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* PhoneNumberConfigs: [ // PhoneNumberConfigs
|
|
62
|
+
* { // PhoneNumberConfig
|
|
63
|
+
* Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
64
|
+
* PhoneType: "SOFT_PHONE" || "DESK_PHONE", // required
|
|
65
|
+
* PhoneNumber: "STRING_VALUE",
|
|
66
|
+
* },
|
|
67
|
+
* ],
|
|
68
|
+
* PersistentConnectionConfigs: [ // PersistentConnectionConfigs
|
|
69
|
+
* { // PersistentConnectionConfig
|
|
70
|
+
* Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
71
|
+
* PersistentConnection: true || false, // required
|
|
72
|
+
* },
|
|
73
|
+
* ],
|
|
74
|
+
* VoiceEnhancementConfigs: [ // VoiceEnhancementConfigs
|
|
75
|
+
* { // VoiceEnhancementConfig
|
|
76
|
+
* Channel: "VOICE" || "CHAT" || "TASK" || "EMAIL", // required
|
|
77
|
+
* VoiceEnhancementMode: "VOICE_ISOLATION" || "NOISE_SUPPRESSION" || "NONE", // required
|
|
78
|
+
* },
|
|
79
|
+
* ],
|
|
80
|
+
* UserId: "STRING_VALUE", // required
|
|
81
|
+
* InstanceId: "STRING_VALUE", // required
|
|
82
|
+
* };
|
|
83
|
+
* const command = new UpdateUserConfigCommand(input);
|
|
84
|
+
* const response = await client.send(command);
|
|
85
|
+
* // {};
|
|
86
|
+
*
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
* @param UpdateUserConfigCommandInput - {@link UpdateUserConfigCommandInput}
|
|
90
|
+
* @returns {@link UpdateUserConfigCommandOutput}
|
|
91
|
+
* @see {@link UpdateUserConfigCommandInput} for command's `input` shape.
|
|
92
|
+
* @see {@link UpdateUserConfigCommandOutput} for command's `response` shape.
|
|
93
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ConditionalOperationFailedException} (client fault)
|
|
96
|
+
* <p>Request processing failed because dependent condition failed.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
99
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
102
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
105
|
+
* <p>The request is not valid.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
108
|
+
* <p>The specified resource was not found.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
111
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link ConnectServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class UpdateUserConfigCommand extends UpdateUserConfigCommand_base {
|
|
120
|
+
/** @internal type navigation helper, not in runtime. */
|
|
121
|
+
protected static __types: {
|
|
122
|
+
api: {
|
|
123
|
+
input: UpdateUserConfigRequest;
|
|
124
|
+
output: {};
|
|
125
|
+
};
|
|
126
|
+
sdk: {
|
|
127
|
+
input: UpdateUserConfigCommandInput;
|
|
128
|
+
output: UpdateUserConfigCommandOutput;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
}
|
|
@@ -28,6 +28,9 @@ declare const UpdateUserPhoneConfigCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates the phone configuration settings for the specified user.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateUserConfig.html">UpdateUserConfig</a> API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.</p>
|
|
33
|
+
* </note>
|
|
31
34
|
* @example
|
|
32
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
36
|
* ```javascript
|
|
@@ -38,7 +41,7 @@ declare const UpdateUserPhoneConfigCommand_base: {
|
|
|
38
41
|
* const client = new ConnectClient(config);
|
|
39
42
|
* const input = { // UpdateUserPhoneConfigRequest
|
|
40
43
|
* PhoneConfig: { // UserPhoneConfig
|
|
41
|
-
* PhoneType: "SOFT_PHONE" || "DESK_PHONE",
|
|
44
|
+
* PhoneType: "SOFT_PHONE" || "DESK_PHONE",
|
|
42
45
|
* AutoAccept: true || false,
|
|
43
46
|
* AfterContactWorkTimeLimit: Number("int"),
|
|
44
47
|
* DeskPhoneNumber: "STRING_VALUE",
|
|
@@ -339,6 +339,7 @@ export * from "./UpdateSecurityProfileCommand";
|
|
|
339
339
|
export * from "./UpdateTaskTemplateCommand";
|
|
340
340
|
export * from "./UpdateTestCaseCommand";
|
|
341
341
|
export * from "./UpdateTrafficDistributionCommand";
|
|
342
|
+
export * from "./UpdateUserConfigCommand";
|
|
342
343
|
export * from "./UpdateUserHierarchyCommand";
|
|
343
344
|
export * from "./UpdateUserHierarchyGroupNameCommand";
|
|
344
345
|
export * from "./UpdateUserHierarchyStructureCommand";
|
|
@@ -28,6 +28,20 @@ export declare const ActionType: {
|
|
|
28
28
|
* @public
|
|
29
29
|
*/
|
|
30
30
|
export type ActionType = (typeof ActionType)[keyof typeof ActionType];
|
|
31
|
+
/**
|
|
32
|
+
* @public
|
|
33
|
+
* @enum
|
|
34
|
+
*/
|
|
35
|
+
export declare const Channel: {
|
|
36
|
+
readonly CHAT: "CHAT";
|
|
37
|
+
readonly EMAIL: "EMAIL";
|
|
38
|
+
readonly TASK: "TASK";
|
|
39
|
+
readonly VOICE: "VOICE";
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export type Channel = (typeof Channel)[keyof typeof Channel];
|
|
31
45
|
/**
|
|
32
46
|
* @public
|
|
33
47
|
* @enum
|
|
@@ -59,20 +73,6 @@ export declare const ContactState: {
|
|
|
59
73
|
* @public
|
|
60
74
|
*/
|
|
61
75
|
export type ContactState = (typeof ContactState)[keyof typeof ContactState];
|
|
62
|
-
/**
|
|
63
|
-
* @public
|
|
64
|
-
* @enum
|
|
65
|
-
*/
|
|
66
|
-
export declare const Channel: {
|
|
67
|
-
readonly CHAT: "CHAT";
|
|
68
|
-
readonly EMAIL: "EMAIL";
|
|
69
|
-
readonly TASK: "TASK";
|
|
70
|
-
readonly VOICE: "VOICE";
|
|
71
|
-
};
|
|
72
|
-
/**
|
|
73
|
-
* @public
|
|
74
|
-
*/
|
|
75
|
-
export type Channel = (typeof Channel)[keyof typeof Channel];
|
|
76
76
|
/**
|
|
77
77
|
* @public
|
|
78
78
|
* @enum
|
|
@@ -1154,6 +1154,19 @@ export declare const PhoneType: {
|
|
|
1154
1154
|
* @public
|
|
1155
1155
|
*/
|
|
1156
1156
|
export type PhoneType = (typeof PhoneType)[keyof typeof PhoneType];
|
|
1157
|
+
/**
|
|
1158
|
+
* @public
|
|
1159
|
+
* @enum
|
|
1160
|
+
*/
|
|
1161
|
+
export declare const VoiceEnhancementMode: {
|
|
1162
|
+
readonly NOISE_SUPPRESSION: "NOISE_SUPPRESSION";
|
|
1163
|
+
readonly NONE: "NONE";
|
|
1164
|
+
readonly VOICE_ISOLATION: "VOICE_ISOLATION";
|
|
1165
|
+
};
|
|
1166
|
+
/**
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
export type VoiceEnhancementMode = (typeof VoiceEnhancementMode)[keyof typeof VoiceEnhancementMode];
|
|
1157
1170
|
/**
|
|
1158
1171
|
* @public
|
|
1159
1172
|
* @enum
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AccessType, ActionType, AgentAvailabilityTimer, AgentStatusState, AgentStatusType, AiUseCase, AllowedUserAction, ApplicationType, AttachedFileInvalidRequestExceptionReason, AttachedFileServiceQuotaExceededExceptionReason, BehaviorType, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactState, DataTableAttributeValueType, DataTableLockLevel, DataTableStatus, DeviceType, DirectoryType, EncryptionType, EndpointType, EntityType, EvaluationFormItemEnablementSourceType, EvaluationFormItemEnablementSourceValueType, EvaluationFormItemSourceValuesComparator, EvaluationFormLanguageCode, EvaluationFormMultiSelectQuestionDisplayMode, EvaluationFormQuestionAutomationAnswerSourceType, EvaluationFormScoringMode, EvaluationFormScoringStatus, EvaluationFormSingleSelectQuestionDisplayMode, EvaluationReviewNotificationRecipientType, EventSourceName, FailureReasonCode, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowModuleType, HoursOfOperationDays, InstanceStorageResourceType, IntegrationType, ListFlowAssociationResourceType, MultiSelectQuestionRuleCategoryAutomationCondition, NotificationContentType, NotificationDeliveryType, NumericQuestionPropertyAutomationLabel, OutboundStrategyType, OverrideDays, OverrideType, ParticipantRole, ParticipantState, PhoneType, PropertyValidationExceptionReason, QuickConnectType, RecurrenceFrequency, ReferenceStatus, ReferenceType, RehydrationType, RulePublishStatus, ScreenShareCapability, SingleSelectQuestionRuleCategoryAutomationCondition, SlaAssignmentType, SlaType, SourceType, StorageType, StringComparisonType, TaskTemplateFieldType, TaskTemplateStatus, TestCaseEntryPointType, TestCaseStatus, UseCaseType, VideoCapability, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState,
|
|
1
|
+
import { AccessType, ActionType, AgentAvailabilityTimer, AgentStatusState, AgentStatusType, AiUseCase, AllowedUserAction, ApplicationType, AttachedFileInvalidRequestExceptionReason, AttachedFileServiceQuotaExceededExceptionReason, BehaviorType, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactInteractionType, ContactState, DataTableAttributeValueType, DataTableLockLevel, DataTableStatus, DeviceType, DirectoryType, EncryptionType, EndpointType, EntityType, EvaluationFormItemEnablementSourceType, EvaluationFormItemEnablementSourceValueType, EvaluationFormItemSourceValuesComparator, EvaluationFormLanguageCode, EvaluationFormMultiSelectQuestionDisplayMode, EvaluationFormQuestionAutomationAnswerSourceType, EvaluationFormScoringMode, EvaluationFormScoringStatus, EvaluationFormSingleSelectQuestionDisplayMode, EvaluationReviewNotificationRecipientType, EventSourceName, FailureReasonCode, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowModuleType, HoursOfOperationDays, InstanceStorageResourceType, IntegrationType, ListFlowAssociationResourceType, MultiSelectQuestionRuleCategoryAutomationCondition, NotificationContentType, NotificationDeliveryType, NumericQuestionPropertyAutomationLabel, OutboundStrategyType, OverrideDays, OverrideType, ParticipantRole, ParticipantState, PhoneType, PropertyValidationExceptionReason, QuickConnectType, RecurrenceFrequency, ReferenceStatus, ReferenceType, RehydrationType, RulePublishStatus, ScreenShareCapability, SingleSelectQuestionRuleCategoryAutomationCondition, SlaAssignmentType, SlaType, SourceType, StorageType, StringComparisonType, TaskTemplateFieldType, TaskTemplateStatus, TestCaseEntryPointType, TestCaseStatus, UseCaseType, VideoCapability, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState, VoiceEnhancementMode } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* <p>Information about an action.</p>
|
|
4
4
|
* @public
|
|
@@ -83,6 +83,38 @@ export interface AdditionalEmailRecipients {
|
|
|
83
83
|
*/
|
|
84
84
|
CcList?: EmailRecipient[] | undefined;
|
|
85
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* <p>Configuration settings for after contact work (ACW) timeout.</p>
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export interface AfterContactWorkConfig {
|
|
91
|
+
/**
|
|
92
|
+
* <p>The ACW timeout duration in seconds. Minimum: 1 second. Maximum: 2,000,000 seconds (24 days). Enter 0 for indefinite ACW time.</p>
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
AfterContactWorkTimeLimit?: number | undefined;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* <p>Configuration settings for after contact work (ACW) timeout for a specific channel.</p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export interface AfterContactWorkConfigPerChannel {
|
|
102
|
+
/**
|
|
103
|
+
* <p>The channel for this ACW timeout configuration. Valid values: VOICE, CHAT, TASK, EMAIL.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
Channel: Channel | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* <p>The ACW timeout settings for this channel.</p>
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
AfterContactWorkConfig: AfterContactWorkConfig | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* <p>The ACW timeout settings for agent-first callbacks. This setting only applies to the VOICE channel.</p>
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
AgentFirstCallbackAfterContactWorkConfig?: AfterContactWorkConfig | undefined;
|
|
117
|
+
}
|
|
86
118
|
/**
|
|
87
119
|
* <p>Information about a traffic distribution.</p>
|
|
88
120
|
* @public
|
|
@@ -6221,6 +6253,27 @@ export interface CreateUseCaseResponse {
|
|
|
6221
6253
|
*/
|
|
6222
6254
|
UseCaseArn?: string | undefined;
|
|
6223
6255
|
}
|
|
6256
|
+
/**
|
|
6257
|
+
* <p>Configuration settings for auto-accept for a specific channel.</p>
|
|
6258
|
+
* @public
|
|
6259
|
+
*/
|
|
6260
|
+
export interface AutoAcceptConfig {
|
|
6261
|
+
/**
|
|
6262
|
+
* <p>The channel for this auto-accept configuration. Valid values: VOICE, CHAT, TASK, EMAIL.</p>
|
|
6263
|
+
* @public
|
|
6264
|
+
*/
|
|
6265
|
+
Channel: Channel | undefined;
|
|
6266
|
+
/**
|
|
6267
|
+
* <p>Indicates whether auto-accept is enabled for this channel. When enabled, available agents are automatically connected to contacts from this channel.</p>
|
|
6268
|
+
* @public
|
|
6269
|
+
*/
|
|
6270
|
+
AutoAccept: boolean | undefined;
|
|
6271
|
+
/**
|
|
6272
|
+
* <p>Indicates whether auto-accept is enabled for agent-first callbacks. This setting only applies to the VOICE channel.</p>
|
|
6273
|
+
* @public
|
|
6274
|
+
*/
|
|
6275
|
+
AgentFirstCallbackAutoAccept?: boolean | undefined;
|
|
6276
|
+
}
|
|
6224
6277
|
/**
|
|
6225
6278
|
* <p>Contains information about the identity of a user.</p>
|
|
6226
6279
|
* <note>
|
|
@@ -6269,6 +6322,23 @@ export interface UserIdentityInfo {
|
|
|
6269
6322
|
*/
|
|
6270
6323
|
Mobile?: string | undefined;
|
|
6271
6324
|
}
|
|
6325
|
+
/**
|
|
6326
|
+
* <p>Configuration settings for persistent connection for a specific channel.</p>
|
|
6327
|
+
* @public
|
|
6328
|
+
*/
|
|
6329
|
+
export interface PersistentConnectionConfig {
|
|
6330
|
+
/**
|
|
6331
|
+
* <p>Configuration settings for persistent connection. <b>Only <code>VOICE</code> is supported for this data type.</b>
|
|
6332
|
+
* </p>
|
|
6333
|
+
* @public
|
|
6334
|
+
*/
|
|
6335
|
+
Channel: Channel | undefined;
|
|
6336
|
+
/**
|
|
6337
|
+
* <p>Indicates whether persistent connection is enabled. When enabled, the agent's connection is maintained after a call ends, enabling subsequent calls to connect faster.</p>
|
|
6338
|
+
* @public
|
|
6339
|
+
*/
|
|
6340
|
+
PersistentConnection: boolean | undefined;
|
|
6341
|
+
}
|
|
6272
6342
|
/**
|
|
6273
6343
|
* <p>Contains information about the phone configuration settings for a user.</p>
|
|
6274
6344
|
* @public
|
|
@@ -6278,7 +6348,7 @@ export interface UserPhoneConfig {
|
|
|
6278
6348
|
* <p>The phone type.</p>
|
|
6279
6349
|
* @public
|
|
6280
6350
|
*/
|
|
6281
|
-
PhoneType
|
|
6351
|
+
PhoneType?: PhoneType | undefined;
|
|
6282
6352
|
/**
|
|
6283
6353
|
* <p>The Auto accept setting.</p>
|
|
6284
6354
|
* @public
|
|
@@ -6307,6 +6377,45 @@ export interface UserPhoneConfig {
|
|
|
6307
6377
|
*/
|
|
6308
6378
|
PersistentConnection?: boolean | undefined;
|
|
6309
6379
|
}
|
|
6380
|
+
/**
|
|
6381
|
+
* <p>Configuration settings for phone type and phone number.</p>
|
|
6382
|
+
* @public
|
|
6383
|
+
*/
|
|
6384
|
+
export interface PhoneNumberConfig {
|
|
6385
|
+
/**
|
|
6386
|
+
* <p>The channel for this phone number configuration. <b>Only <code>VOICE</code> is supported for this data type.</b>
|
|
6387
|
+
* </p>
|
|
6388
|
+
* @public
|
|
6389
|
+
*/
|
|
6390
|
+
Channel: Channel | undefined;
|
|
6391
|
+
/**
|
|
6392
|
+
* <p>The phone type. Valid values: SOFT_PHONE, DESK_PHONE.</p>
|
|
6393
|
+
* @public
|
|
6394
|
+
*/
|
|
6395
|
+
PhoneType: PhoneType | undefined;
|
|
6396
|
+
/**
|
|
6397
|
+
* <p>The phone number for the user's desk phone.</p>
|
|
6398
|
+
* @public
|
|
6399
|
+
*/
|
|
6400
|
+
PhoneNumber?: string | undefined;
|
|
6401
|
+
}
|
|
6402
|
+
/**
|
|
6403
|
+
* <p>Configuration settings for voice enhancement.</p>
|
|
6404
|
+
* @public
|
|
6405
|
+
*/
|
|
6406
|
+
export interface VoiceEnhancementConfig {
|
|
6407
|
+
/**
|
|
6408
|
+
* <p>The channel for this voice enhancement configuration. <b>Only <code>VOICE</code> is supported for this data type.</b>
|
|
6409
|
+
* </p>
|
|
6410
|
+
* @public
|
|
6411
|
+
*/
|
|
6412
|
+
Channel: Channel | undefined;
|
|
6413
|
+
/**
|
|
6414
|
+
* <p>The voice enhancement mode.</p>
|
|
6415
|
+
* @public
|
|
6416
|
+
*/
|
|
6417
|
+
VoiceEnhancementMode: VoiceEnhancementMode | undefined;
|
|
6418
|
+
}
|
|
6310
6419
|
/**
|
|
6311
6420
|
* @public
|
|
6312
6421
|
*/
|
|
@@ -6342,10 +6451,10 @@ export interface CreateUserRequest {
|
|
|
6342
6451
|
*/
|
|
6343
6452
|
IdentityInfo?: UserIdentityInfo | undefined;
|
|
6344
6453
|
/**
|
|
6345
|
-
* <p>The phone settings for the user
|
|
6454
|
+
* <p>The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as <code>AutoAcceptConfigs</code>, <code>AfterContactWorkConfigs</code>, <code>PhoneNumberConfigs</code>, <code>PersistentConnectionConfigs</code>, and <code>VoiceEnhancementConfigs</code>.</p>
|
|
6346
6455
|
* @public
|
|
6347
6456
|
*/
|
|
6348
|
-
PhoneConfig
|
|
6457
|
+
PhoneConfig?: UserPhoneConfig | undefined;
|
|
6349
6458
|
/**
|
|
6350
6459
|
* <p>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot
|
|
6351
6460
|
* access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume
|
|
@@ -6377,6 +6486,31 @@ export interface CreateUserRequest {
|
|
|
6377
6486
|
* @public
|
|
6378
6487
|
*/
|
|
6379
6488
|
InstanceId: string | undefined;
|
|
6489
|
+
/**
|
|
6490
|
+
* <p>The list of auto-accept configuration settings for each channel.</p>
|
|
6491
|
+
* @public
|
|
6492
|
+
*/
|
|
6493
|
+
AutoAcceptConfigs?: AutoAcceptConfig[] | undefined;
|
|
6494
|
+
/**
|
|
6495
|
+
* <p>The list of after contact work (ACW) timeout configuration settings for each channel.</p>
|
|
6496
|
+
* @public
|
|
6497
|
+
*/
|
|
6498
|
+
AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined;
|
|
6499
|
+
/**
|
|
6500
|
+
* <p>The list of phone number configuration settings for each channel.</p>
|
|
6501
|
+
* @public
|
|
6502
|
+
*/
|
|
6503
|
+
PhoneNumberConfigs?: PhoneNumberConfig[] | undefined;
|
|
6504
|
+
/**
|
|
6505
|
+
* <p>The list of persistent connection configuration settings for each channel.</p>
|
|
6506
|
+
* @public
|
|
6507
|
+
*/
|
|
6508
|
+
PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined;
|
|
6509
|
+
/**
|
|
6510
|
+
* <p>The list of voice enhancement configuration settings for each channel.</p>
|
|
6511
|
+
* @public
|
|
6512
|
+
*/
|
|
6513
|
+
VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined;
|
|
6380
6514
|
/**
|
|
6381
6515
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
6382
6516
|
* @public
|
|
@@ -6867,114 +7001,3 @@ export interface WorkspaceThemePalette {
|
|
|
6867
7001
|
*/
|
|
6868
7002
|
Primary?: PalettePrimary | undefined;
|
|
6869
7003
|
}
|
|
6870
|
-
/**
|
|
6871
|
-
* <p>Contains font family configuration for workspace themes.</p>
|
|
6872
|
-
* @public
|
|
6873
|
-
*/
|
|
6874
|
-
export interface FontFamily {
|
|
6875
|
-
/**
|
|
6876
|
-
* <p>The default font family to use in the workspace theme.</p>
|
|
6877
|
-
* @public
|
|
6878
|
-
*/
|
|
6879
|
-
Default?: WorkspaceFontFamily | undefined;
|
|
6880
|
-
}
|
|
6881
|
-
/**
|
|
6882
|
-
* <p>Contains typography configuration for a workspace theme.</p>
|
|
6883
|
-
* @public
|
|
6884
|
-
*/
|
|
6885
|
-
export interface WorkspaceThemeTypography {
|
|
6886
|
-
/**
|
|
6887
|
-
* <p>The font family configuration for text in the workspace.</p>
|
|
6888
|
-
* @public
|
|
6889
|
-
*/
|
|
6890
|
-
FontFamily?: FontFamily | undefined;
|
|
6891
|
-
}
|
|
6892
|
-
/**
|
|
6893
|
-
* <p>Contains detailed theme configuration for a workspace, including colors, images, and typography.</p>
|
|
6894
|
-
* @public
|
|
6895
|
-
*/
|
|
6896
|
-
export interface WorkspaceThemeConfig {
|
|
6897
|
-
/**
|
|
6898
|
-
* <p>The color palette configuration for the workspace theme.</p>
|
|
6899
|
-
* @public
|
|
6900
|
-
*/
|
|
6901
|
-
Palette?: WorkspaceThemePalette | undefined;
|
|
6902
|
-
/**
|
|
6903
|
-
* <p>The image assets used in the workspace theme.</p>
|
|
6904
|
-
* @public
|
|
6905
|
-
*/
|
|
6906
|
-
Images?: WorkspaceThemeImages | undefined;
|
|
6907
|
-
/**
|
|
6908
|
-
* <p>The typography configuration for the workspace theme.</p>
|
|
6909
|
-
* @public
|
|
6910
|
-
*/
|
|
6911
|
-
Typography?: WorkspaceThemeTypography | undefined;
|
|
6912
|
-
}
|
|
6913
|
-
/**
|
|
6914
|
-
* <p>Contains theme configuration for a workspace, supporting both light and dark modes.</p>
|
|
6915
|
-
* @public
|
|
6916
|
-
*/
|
|
6917
|
-
export interface WorkspaceTheme {
|
|
6918
|
-
/**
|
|
6919
|
-
* <p>The theme configuration for light mode.</p>
|
|
6920
|
-
* @public
|
|
6921
|
-
*/
|
|
6922
|
-
Light?: WorkspaceThemeConfig | undefined;
|
|
6923
|
-
/**
|
|
6924
|
-
* <p>The theme configuration for dark mode.</p>
|
|
6925
|
-
* @public
|
|
6926
|
-
*/
|
|
6927
|
-
Dark?: WorkspaceThemeConfig | undefined;
|
|
6928
|
-
}
|
|
6929
|
-
/**
|
|
6930
|
-
* @public
|
|
6931
|
-
*/
|
|
6932
|
-
export interface CreateWorkspaceRequest {
|
|
6933
|
-
/**
|
|
6934
|
-
* <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
|
|
6935
|
-
* the Amazon Resource Name (ARN) of the instance.</p>
|
|
6936
|
-
* @public
|
|
6937
|
-
*/
|
|
6938
|
-
InstanceId: string | undefined;
|
|
6939
|
-
/**
|
|
6940
|
-
* <p>The name of the workspace. Must be unique within the instance and can contain 1-127 characters.</p>
|
|
6941
|
-
* @public
|
|
6942
|
-
*/
|
|
6943
|
-
Name: string | undefined;
|
|
6944
|
-
/**
|
|
6945
|
-
* <p>The description of the workspace. Maximum length is 250 characters.</p>
|
|
6946
|
-
* @public
|
|
6947
|
-
*/
|
|
6948
|
-
Description?: string | undefined;
|
|
6949
|
-
/**
|
|
6950
|
-
* <p>The theme configuration for the workspace, including colors and styling.</p>
|
|
6951
|
-
* @public
|
|
6952
|
-
*/
|
|
6953
|
-
Theme?: WorkspaceTheme | undefined;
|
|
6954
|
-
/**
|
|
6955
|
-
* <p>The title displayed for the workspace.</p>
|
|
6956
|
-
* @public
|
|
6957
|
-
*/
|
|
6958
|
-
Title?: string | undefined;
|
|
6959
|
-
/**
|
|
6960
|
-
* <p>The tags used to organize, track, or control access for this resource. For example, <code>\{ "Tags":
|
|
6961
|
-
* \{"key1":"value1", "key2":"value2"\} \}</code>.</p>
|
|
6962
|
-
* @public
|
|
6963
|
-
*/
|
|
6964
|
-
Tags?: Record<string, string> | undefined;
|
|
6965
|
-
}
|
|
6966
|
-
/**
|
|
6967
|
-
* @public
|
|
6968
|
-
*/
|
|
6969
|
-
export interface CreateWorkspaceResponse {
|
|
6970
|
-
/**
|
|
6971
|
-
* <p>The identifier of the workspace.</p>
|
|
6972
|
-
* @public
|
|
6973
|
-
*/
|
|
6974
|
-
WorkspaceId: string | undefined;
|
|
6975
|
-
/**
|
|
6976
|
-
* <p>The Amazon Resource Name (ARN) of the workspace.</p>
|
|
6977
|
-
* @public
|
|
6978
|
-
*/
|
|
6979
|
-
WorkspaceArn: string | undefined;
|
|
6980
|
-
}
|