@aws-sdk/client-connectcampaignsv2 3.694.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/LICENSE +201 -0
- package/README.md +461 -0
- package/dist-cjs/ConnectCampaignsV2.js +75 -0
- package/dist-cjs/ConnectCampaignsV2Client.js +50 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/CreateCampaignCommand.js +27 -0
- package/dist-cjs/commands/DeleteCampaignChannelSubtypeConfigCommand.js +26 -0
- package/dist-cjs/commands/DeleteCampaignCommand.js +26 -0
- package/dist-cjs/commands/DeleteCampaignCommunicationLimitsCommand.js +26 -0
- package/dist-cjs/commands/DeleteCampaignCommunicationTimeCommand.js +26 -0
- package/dist-cjs/commands/DeleteConnectInstanceConfigCommand.js +26 -0
- package/dist-cjs/commands/DeleteConnectInstanceIntegrationCommand.js +26 -0
- package/dist-cjs/commands/DeleteInstanceOnboardingJobCommand.js +26 -0
- package/dist-cjs/commands/DescribeCampaignCommand.js +27 -0
- package/dist-cjs/commands/GetCampaignStateBatchCommand.js +26 -0
- package/dist-cjs/commands/GetCampaignStateCommand.js +26 -0
- package/dist-cjs/commands/GetConnectInstanceConfigCommand.js +26 -0
- package/dist-cjs/commands/GetInstanceOnboardingJobStatusCommand.js +26 -0
- package/dist-cjs/commands/ListCampaignsCommand.js +26 -0
- package/dist-cjs/commands/ListConnectInstanceIntegrationsCommand.js +26 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +26 -0
- package/dist-cjs/commands/PauseCampaignCommand.js +26 -0
- package/dist-cjs/commands/PutConnectInstanceIntegrationCommand.js +26 -0
- package/dist-cjs/commands/PutOutboundRequestBatchCommand.js +27 -0
- package/dist-cjs/commands/ResumeCampaignCommand.js +26 -0
- package/dist-cjs/commands/StartCampaignCommand.js +26 -0
- package/dist-cjs/commands/StartInstanceOnboardingJobCommand.js +26 -0
- package/dist-cjs/commands/StopCampaignCommand.js +26 -0
- package/dist-cjs/commands/TagResourceCommand.js +26 -0
- package/dist-cjs/commands/UntagResourceCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignChannelSubtypeConfigCommand.js +27 -0
- package/dist-cjs/commands/UpdateCampaignCommunicationLimitsCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignCommunicationTimeCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignFlowAssociationCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignNameCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignScheduleCommand.js +26 -0
- package/dist-cjs/commands/UpdateCampaignSourceCommand.js +26 -0
- package/dist-cjs/commands/index.js +35 -0
- package/dist-cjs/endpoint/EndpointParameters.js +18 -0
- package/dist-cjs/endpoint/endpointResolver.js +18 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/ConnectCampaignsV2ServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +409 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListCampaignsPaginator.js +7 -0
- package/dist-cjs/pagination/ListConnectInstanceIntegrationsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1193 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/ConnectCampaignsV2.js +71 -0
- package/dist-es/ConnectCampaignsV2Client.js +46 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/CreateCampaignCommand.js +23 -0
- package/dist-es/commands/DeleteCampaignChannelSubtypeConfigCommand.js +22 -0
- package/dist-es/commands/DeleteCampaignCommand.js +22 -0
- package/dist-es/commands/DeleteCampaignCommunicationLimitsCommand.js +22 -0
- package/dist-es/commands/DeleteCampaignCommunicationTimeCommand.js +22 -0
- package/dist-es/commands/DeleteConnectInstanceConfigCommand.js +22 -0
- package/dist-es/commands/DeleteConnectInstanceIntegrationCommand.js +22 -0
- package/dist-es/commands/DeleteInstanceOnboardingJobCommand.js +22 -0
- package/dist-es/commands/DescribeCampaignCommand.js +23 -0
- package/dist-es/commands/GetCampaignStateBatchCommand.js +22 -0
- package/dist-es/commands/GetCampaignStateCommand.js +22 -0
- package/dist-es/commands/GetConnectInstanceConfigCommand.js +22 -0
- package/dist-es/commands/GetInstanceOnboardingJobStatusCommand.js +22 -0
- package/dist-es/commands/ListCampaignsCommand.js +22 -0
- package/dist-es/commands/ListConnectInstanceIntegrationsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/PauseCampaignCommand.js +22 -0
- package/dist-es/commands/PutConnectInstanceIntegrationCommand.js +22 -0
- package/dist-es/commands/PutOutboundRequestBatchCommand.js +23 -0
- package/dist-es/commands/ResumeCampaignCommand.js +22 -0
- package/dist-es/commands/StartCampaignCommand.js +22 -0
- package/dist-es/commands/StartInstanceOnboardingJobCommand.js +22 -0
- package/dist-es/commands/StopCampaignCommand.js +22 -0
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignChannelSubtypeConfigCommand.js +23 -0
- package/dist-es/commands/UpdateCampaignCommunicationLimitsCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignCommunicationTimeCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignFlowAssociationCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignNameCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignScheduleCommand.js +22 -0
- package/dist-es/commands/UpdateCampaignSourceCommand.js +22 -0
- package/dist-es/commands/index.js +32 -0
- package/dist-es/endpoint/EndpointParameters.js +14 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/ConnectCampaignsV2ServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +384 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListCampaignsPaginator.js +4 -0
- package/dist-es/pagination/ListConnectInstanceIntegrationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1125 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/ConnectCampaignsV2.d.ts +235 -0
- package/dist-types/ConnectCampaignsV2Client.d.ts +201 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/CreateCampaignCommand.d.ts +235 -0
- package/dist-types/commands/DeleteCampaignChannelSubtypeConfigCommand.d.ts +85 -0
- package/dist-types/commands/DeleteCampaignCommand.d.ts +81 -0
- package/dist-types/commands/DeleteCampaignCommunicationLimitsCommand.d.ts +88 -0
- package/dist-types/commands/DeleteCampaignCommunicationTimeCommand.d.ts +88 -0
- package/dist-types/commands/DeleteConnectInstanceConfigCommand.d.ts +88 -0
- package/dist-types/commands/DeleteConnectInstanceIntegrationCommand.d.ts +92 -0
- package/dist-types/commands/DeleteInstanceOnboardingJobCommand.d.ts +84 -0
- package/dist-types/commands/DescribeCampaignCommand.d.ts +226 -0
- package/dist-types/commands/GetCampaignStateBatchCommand.d.ts +96 -0
- package/dist-types/commands/GetCampaignStateCommand.d.ts +86 -0
- package/dist-types/commands/GetConnectInstanceConfigCommand.d.ts +91 -0
- package/dist-types/commands/GetInstanceOnboardingJobStatusCommand.d.ts +87 -0
- package/dist-types/commands/ListCampaignsCommand.d.ts +104 -0
- package/dist-types/commands/ListConnectInstanceIntegrationsCommand.d.ts +101 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +88 -0
- package/dist-types/commands/PauseCampaignCommand.d.ts +90 -0
- package/dist-types/commands/PutConnectInstanceIntegrationCommand.d.ts +98 -0
- package/dist-types/commands/PutOutboundRequestBatchCommand.d.ts +139 -0
- package/dist-types/commands/ResumeCampaignCommand.d.ts +90 -0
- package/dist-types/commands/StartCampaignCommand.d.ts +90 -0
- package/dist-types/commands/StartInstanceOnboardingJobCommand.d.ts +98 -0
- package/dist-types/commands/StopCampaignCommand.d.ts +90 -0
- package/dist-types/commands/TagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateCampaignChannelSubtypeConfigCommand.d.ts +128 -0
- package/dist-types/commands/UpdateCampaignCommunicationLimitsCommand.d.ts +98 -0
- package/dist-types/commands/UpdateCampaignCommunicationTimeCommand.d.ts +158 -0
- package/dist-types/commands/UpdateCampaignFlowAssociationCommand.d.ts +88 -0
- package/dist-types/commands/UpdateCampaignNameCommand.d.ts +85 -0
- package/dist-types/commands/UpdateCampaignScheduleCommand.d.ts +92 -0
- package/dist-types/commands/UpdateCampaignSourceCommand.d.ts +90 -0
- package/dist-types/commands/index.d.ts +32 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +40 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +14 -0
- package/dist-types/models/ConnectCampaignsV2ServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2299 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListCampaignsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConnectInstanceIntegrationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +290 -0
- package/dist-types/runtimeConfig.browser.d.ts +48 -0
- package/dist-types/runtimeConfig.d.ts +48 -0
- package/dist-types/runtimeConfig.native.d.ts +47 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/ConnectCampaignsV2.d.ts +576 -0
- package/dist-types/ts3.4/ConnectCampaignsV2Client.d.ts +313 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/CreateCampaignCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteCampaignChannelSubtypeConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommunicationLimitsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteCampaignCommunicationTimeCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteConnectInstanceConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteConnectInstanceIntegrationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteInstanceOnboardingJobCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeCampaignCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetCampaignStateBatchCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCampaignStateCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetConnectInstanceConfigCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetInstanceOnboardingJobStatusCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCampaignsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListConnectInstanceIntegrationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PauseCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/PutConnectInstanceIntegrationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/PutOutboundRequestBatchCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ResumeCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/StartCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/StartInstanceOnboardingJobCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopCampaignCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/UpdateCampaignChannelSubtypeConfigCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignCommunicationLimitsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignCommunicationTimeCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignFlowAssociationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateCampaignNameCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateCampaignScheduleCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/UpdateCampaignSourceCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/index.d.ts +32 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +51 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/ConnectCampaignsV2ServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +827 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListCampaignsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListConnectInstanceIntegrationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +389 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +96 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +89 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +101 -0
|
@@ -0,0 +1,827 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { ConnectCampaignsV2ServiceException as __BaseException } from "./ConnectCampaignsV2ServiceException";
|
|
3
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
4
|
+
readonly name: "AccessDeniedException";
|
|
5
|
+
readonly $fault: "client";
|
|
6
|
+
xAmzErrorType?: string | undefined;
|
|
7
|
+
constructor(
|
|
8
|
+
opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
|
|
9
|
+
);
|
|
10
|
+
}
|
|
11
|
+
export interface AgentlessConfig {}
|
|
12
|
+
export declare class ConflictException extends __BaseException {
|
|
13
|
+
readonly name: "ConflictException";
|
|
14
|
+
readonly $fault: "client";
|
|
15
|
+
xAmzErrorType?: string | undefined;
|
|
16
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
17
|
+
}
|
|
18
|
+
export interface EmailOutboundConfig {
|
|
19
|
+
connectSourceEmailAddress: string | undefined;
|
|
20
|
+
sourceEmailAddressDisplayName?: string | undefined;
|
|
21
|
+
wisdomTemplateArn: string | undefined;
|
|
22
|
+
}
|
|
23
|
+
export type EmailOutboundMode =
|
|
24
|
+
| EmailOutboundMode.AgentlessMember
|
|
25
|
+
| EmailOutboundMode.$UnknownMember;
|
|
26
|
+
export declare namespace EmailOutboundMode {
|
|
27
|
+
interface AgentlessMember {
|
|
28
|
+
agentless: AgentlessConfig;
|
|
29
|
+
$unknown?: never;
|
|
30
|
+
}
|
|
31
|
+
interface $UnknownMember {
|
|
32
|
+
agentless?: never;
|
|
33
|
+
$unknown: [string, any];
|
|
34
|
+
}
|
|
35
|
+
interface Visitor<T> {
|
|
36
|
+
agentless: (value: AgentlessConfig) => T;
|
|
37
|
+
_: (name: string, value: any) => T;
|
|
38
|
+
}
|
|
39
|
+
const visit: <T>(value: EmailOutboundMode, visitor: Visitor<T>) => T;
|
|
40
|
+
}
|
|
41
|
+
export interface EmailChannelSubtypeConfig {
|
|
42
|
+
capacity?: number | undefined;
|
|
43
|
+
outboundMode: EmailOutboundMode | undefined;
|
|
44
|
+
defaultOutboundConfig: EmailOutboundConfig | undefined;
|
|
45
|
+
}
|
|
46
|
+
export interface SmsOutboundConfig {
|
|
47
|
+
connectSourcePhoneNumberArn: string | undefined;
|
|
48
|
+
wisdomTemplateArn: string | undefined;
|
|
49
|
+
}
|
|
50
|
+
export type SmsOutboundMode =
|
|
51
|
+
| SmsOutboundMode.AgentlessMember
|
|
52
|
+
| SmsOutboundMode.$UnknownMember;
|
|
53
|
+
export declare namespace SmsOutboundMode {
|
|
54
|
+
interface AgentlessMember {
|
|
55
|
+
agentless: AgentlessConfig;
|
|
56
|
+
$unknown?: never;
|
|
57
|
+
}
|
|
58
|
+
interface $UnknownMember {
|
|
59
|
+
agentless?: never;
|
|
60
|
+
$unknown: [string, any];
|
|
61
|
+
}
|
|
62
|
+
interface Visitor<T> {
|
|
63
|
+
agentless: (value: AgentlessConfig) => T;
|
|
64
|
+
_: (name: string, value: any) => T;
|
|
65
|
+
}
|
|
66
|
+
const visit: <T>(value: SmsOutboundMode, visitor: Visitor<T>) => T;
|
|
67
|
+
}
|
|
68
|
+
export interface SmsChannelSubtypeConfig {
|
|
69
|
+
capacity?: number | undefined;
|
|
70
|
+
outboundMode: SmsOutboundMode | undefined;
|
|
71
|
+
defaultOutboundConfig: SmsOutboundConfig | undefined;
|
|
72
|
+
}
|
|
73
|
+
export interface AnswerMachineDetectionConfig {
|
|
74
|
+
enableAnswerMachineDetection: boolean | undefined;
|
|
75
|
+
awaitAnswerMachinePrompt?: boolean | undefined;
|
|
76
|
+
}
|
|
77
|
+
export interface TelephonyOutboundConfig {
|
|
78
|
+
connectContactFlowId: string | undefined;
|
|
79
|
+
connectSourcePhoneNumber?: string | undefined;
|
|
80
|
+
answerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined;
|
|
81
|
+
}
|
|
82
|
+
export interface PredictiveConfig {
|
|
83
|
+
bandwidthAllocation: number | undefined;
|
|
84
|
+
}
|
|
85
|
+
export interface ProgressiveConfig {
|
|
86
|
+
bandwidthAllocation: number | undefined;
|
|
87
|
+
}
|
|
88
|
+
export type TelephonyOutboundMode =
|
|
89
|
+
| TelephonyOutboundMode.AgentlessMember
|
|
90
|
+
| TelephonyOutboundMode.PredictiveMember
|
|
91
|
+
| TelephonyOutboundMode.ProgressiveMember
|
|
92
|
+
| TelephonyOutboundMode.$UnknownMember;
|
|
93
|
+
export declare namespace TelephonyOutboundMode {
|
|
94
|
+
interface ProgressiveMember {
|
|
95
|
+
progressive: ProgressiveConfig;
|
|
96
|
+
predictive?: never;
|
|
97
|
+
agentless?: never;
|
|
98
|
+
$unknown?: never;
|
|
99
|
+
}
|
|
100
|
+
interface PredictiveMember {
|
|
101
|
+
progressive?: never;
|
|
102
|
+
predictive: PredictiveConfig;
|
|
103
|
+
agentless?: never;
|
|
104
|
+
$unknown?: never;
|
|
105
|
+
}
|
|
106
|
+
interface AgentlessMember {
|
|
107
|
+
progressive?: never;
|
|
108
|
+
predictive?: never;
|
|
109
|
+
agentless: AgentlessConfig;
|
|
110
|
+
$unknown?: never;
|
|
111
|
+
}
|
|
112
|
+
interface $UnknownMember {
|
|
113
|
+
progressive?: never;
|
|
114
|
+
predictive?: never;
|
|
115
|
+
agentless?: never;
|
|
116
|
+
$unknown: [string, any];
|
|
117
|
+
}
|
|
118
|
+
interface Visitor<T> {
|
|
119
|
+
progressive: (value: ProgressiveConfig) => T;
|
|
120
|
+
predictive: (value: PredictiveConfig) => T;
|
|
121
|
+
agentless: (value: AgentlessConfig) => T;
|
|
122
|
+
_: (name: string, value: any) => T;
|
|
123
|
+
}
|
|
124
|
+
const visit: <T>(value: TelephonyOutboundMode, visitor: Visitor<T>) => T;
|
|
125
|
+
}
|
|
126
|
+
export interface TelephonyChannelSubtypeConfig {
|
|
127
|
+
capacity?: number | undefined;
|
|
128
|
+
connectQueueId?: string | undefined;
|
|
129
|
+
outboundMode: TelephonyOutboundMode | undefined;
|
|
130
|
+
defaultOutboundConfig: TelephonyOutboundConfig | undefined;
|
|
131
|
+
}
|
|
132
|
+
export interface ChannelSubtypeConfig {
|
|
133
|
+
telephony?: TelephonyChannelSubtypeConfig | undefined;
|
|
134
|
+
sms?: SmsChannelSubtypeConfig | undefined;
|
|
135
|
+
email?: EmailChannelSubtypeConfig | undefined;
|
|
136
|
+
}
|
|
137
|
+
export declare const CommunicationLimitTimeUnit: {
|
|
138
|
+
readonly DAY: "DAY";
|
|
139
|
+
};
|
|
140
|
+
export type CommunicationLimitTimeUnit =
|
|
141
|
+
(typeof CommunicationLimitTimeUnit)[keyof typeof CommunicationLimitTimeUnit];
|
|
142
|
+
export interface CommunicationLimit {
|
|
143
|
+
maxCountPerRecipient: number | undefined;
|
|
144
|
+
frequency: number | undefined;
|
|
145
|
+
unit: CommunicationLimitTimeUnit | undefined;
|
|
146
|
+
}
|
|
147
|
+
export type CommunicationLimits =
|
|
148
|
+
| CommunicationLimits.CommunicationLimitsListMember
|
|
149
|
+
| CommunicationLimits.$UnknownMember;
|
|
150
|
+
export declare namespace CommunicationLimits {
|
|
151
|
+
interface CommunicationLimitsListMember {
|
|
152
|
+
communicationLimitsList: CommunicationLimit[];
|
|
153
|
+
$unknown?: never;
|
|
154
|
+
}
|
|
155
|
+
interface $UnknownMember {
|
|
156
|
+
communicationLimitsList?: never;
|
|
157
|
+
$unknown: [string, any];
|
|
158
|
+
}
|
|
159
|
+
interface Visitor<T> {
|
|
160
|
+
communicationLimitsList: (value: CommunicationLimit[]) => T;
|
|
161
|
+
_: (name: string, value: any) => T;
|
|
162
|
+
}
|
|
163
|
+
const visit: <T>(value: CommunicationLimits, visitor: Visitor<T>) => T;
|
|
164
|
+
}
|
|
165
|
+
export interface CommunicationLimitsConfig {
|
|
166
|
+
allChannelSubtypes?: CommunicationLimits | undefined;
|
|
167
|
+
}
|
|
168
|
+
export declare const DayOfWeek: {
|
|
169
|
+
readonly FRIDAY: "FRIDAY";
|
|
170
|
+
readonly MONDAY: "MONDAY";
|
|
171
|
+
readonly SATURDAY: "SATURDAY";
|
|
172
|
+
readonly SUNDAY: "SUNDAY";
|
|
173
|
+
readonly THURSDAY: "THURSDAY";
|
|
174
|
+
readonly TUESDAY: "TUESDAY";
|
|
175
|
+
readonly WEDNESDAY: "WEDNESDAY";
|
|
176
|
+
};
|
|
177
|
+
export type DayOfWeek = (typeof DayOfWeek)[keyof typeof DayOfWeek];
|
|
178
|
+
export interface TimeRange {
|
|
179
|
+
startTime: string | undefined;
|
|
180
|
+
endTime: string | undefined;
|
|
181
|
+
}
|
|
182
|
+
export type OpenHours = OpenHours.DailyHoursMember | OpenHours.$UnknownMember;
|
|
183
|
+
export declare namespace OpenHours {
|
|
184
|
+
interface DailyHoursMember {
|
|
185
|
+
dailyHours: Partial<Record<DayOfWeek, TimeRange[]>>;
|
|
186
|
+
$unknown?: never;
|
|
187
|
+
}
|
|
188
|
+
interface $UnknownMember {
|
|
189
|
+
dailyHours?: never;
|
|
190
|
+
$unknown: [string, any];
|
|
191
|
+
}
|
|
192
|
+
interface Visitor<T> {
|
|
193
|
+
dailyHours: (value: Partial<Record<DayOfWeek, TimeRange[]>>) => T;
|
|
194
|
+
_: (name: string, value: any) => T;
|
|
195
|
+
}
|
|
196
|
+
const visit: <T>(value: OpenHours, visitor: Visitor<T>) => T;
|
|
197
|
+
}
|
|
198
|
+
export interface RestrictedPeriod {
|
|
199
|
+
name?: string | undefined;
|
|
200
|
+
startDate: string | undefined;
|
|
201
|
+
endDate: string | undefined;
|
|
202
|
+
}
|
|
203
|
+
export type RestrictedPeriods =
|
|
204
|
+
| RestrictedPeriods.RestrictedPeriodListMember
|
|
205
|
+
| RestrictedPeriods.$UnknownMember;
|
|
206
|
+
export declare namespace RestrictedPeriods {
|
|
207
|
+
interface RestrictedPeriodListMember {
|
|
208
|
+
restrictedPeriodList: RestrictedPeriod[];
|
|
209
|
+
$unknown?: never;
|
|
210
|
+
}
|
|
211
|
+
interface $UnknownMember {
|
|
212
|
+
restrictedPeriodList?: never;
|
|
213
|
+
$unknown: [string, any];
|
|
214
|
+
}
|
|
215
|
+
interface Visitor<T> {
|
|
216
|
+
restrictedPeriodList: (value: RestrictedPeriod[]) => T;
|
|
217
|
+
_: (name: string, value: any) => T;
|
|
218
|
+
}
|
|
219
|
+
const visit: <T>(value: RestrictedPeriods, visitor: Visitor<T>) => T;
|
|
220
|
+
}
|
|
221
|
+
export interface TimeWindow {
|
|
222
|
+
openHours: OpenHours | undefined;
|
|
223
|
+
restrictedPeriods?: RestrictedPeriods | undefined;
|
|
224
|
+
}
|
|
225
|
+
export declare const LocalTimeZoneDetectionType: {
|
|
226
|
+
readonly AREA_CODE: "AREA_CODE";
|
|
227
|
+
readonly ZIP_CODE: "ZIP_CODE";
|
|
228
|
+
};
|
|
229
|
+
export type LocalTimeZoneDetectionType =
|
|
230
|
+
(typeof LocalTimeZoneDetectionType)[keyof typeof LocalTimeZoneDetectionType];
|
|
231
|
+
export interface LocalTimeZoneConfig {
|
|
232
|
+
defaultTimeZone?: string | undefined;
|
|
233
|
+
localTimeZoneDetection?: LocalTimeZoneDetectionType[] | undefined;
|
|
234
|
+
}
|
|
235
|
+
export interface CommunicationTimeConfig {
|
|
236
|
+
localTimeZoneConfig: LocalTimeZoneConfig | undefined;
|
|
237
|
+
telephony?: TimeWindow | undefined;
|
|
238
|
+
sms?: TimeWindow | undefined;
|
|
239
|
+
email?: TimeWindow | undefined;
|
|
240
|
+
}
|
|
241
|
+
export interface Schedule {
|
|
242
|
+
startTime: Date | undefined;
|
|
243
|
+
endTime: Date | undefined;
|
|
244
|
+
refreshFrequency?: string | undefined;
|
|
245
|
+
}
|
|
246
|
+
export type Source =
|
|
247
|
+
| Source.CustomerProfilesSegmentArnMember
|
|
248
|
+
| Source.$UnknownMember;
|
|
249
|
+
export declare namespace Source {
|
|
250
|
+
interface CustomerProfilesSegmentArnMember {
|
|
251
|
+
customerProfilesSegmentArn: string;
|
|
252
|
+
$unknown?: never;
|
|
253
|
+
}
|
|
254
|
+
interface $UnknownMember {
|
|
255
|
+
customerProfilesSegmentArn?: never;
|
|
256
|
+
$unknown: [string, any];
|
|
257
|
+
}
|
|
258
|
+
interface Visitor<T> {
|
|
259
|
+
customerProfilesSegmentArn: (value: string) => T;
|
|
260
|
+
_: (name: string, value: any) => T;
|
|
261
|
+
}
|
|
262
|
+
const visit: <T>(value: Source, visitor: Visitor<T>) => T;
|
|
263
|
+
}
|
|
264
|
+
export interface CreateCampaignRequest {
|
|
265
|
+
name: string | undefined;
|
|
266
|
+
connectInstanceId: string | undefined;
|
|
267
|
+
channelSubtypeConfig: ChannelSubtypeConfig | undefined;
|
|
268
|
+
source?: Source | undefined;
|
|
269
|
+
connectCampaignFlowArn?: string | undefined;
|
|
270
|
+
schedule?: Schedule | undefined;
|
|
271
|
+
communicationTimeConfig?: CommunicationTimeConfig | undefined;
|
|
272
|
+
communicationLimitsOverride?: CommunicationLimitsConfig | undefined;
|
|
273
|
+
tags?: Record<string, string> | undefined;
|
|
274
|
+
}
|
|
275
|
+
export interface CreateCampaignResponse {
|
|
276
|
+
id?: string | undefined;
|
|
277
|
+
arn?: string | undefined;
|
|
278
|
+
tags?: Record<string, string> | undefined;
|
|
279
|
+
}
|
|
280
|
+
export declare class InternalServerException extends __BaseException {
|
|
281
|
+
readonly name: "InternalServerException";
|
|
282
|
+
readonly $fault: "server";
|
|
283
|
+
$retryable: {};
|
|
284
|
+
xAmzErrorType?: string | undefined;
|
|
285
|
+
constructor(
|
|
286
|
+
opts: __ExceptionOptionType<InternalServerException, __BaseException>
|
|
287
|
+
);
|
|
288
|
+
}
|
|
289
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
290
|
+
readonly name: "ResourceNotFoundException";
|
|
291
|
+
readonly $fault: "client";
|
|
292
|
+
xAmzErrorType?: string | undefined;
|
|
293
|
+
constructor(
|
|
294
|
+
opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
|
|
295
|
+
);
|
|
296
|
+
}
|
|
297
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
298
|
+
readonly name: "ServiceQuotaExceededException";
|
|
299
|
+
readonly $fault: "client";
|
|
300
|
+
xAmzErrorType?: string | undefined;
|
|
301
|
+
constructor(
|
|
302
|
+
opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
|
|
303
|
+
);
|
|
304
|
+
}
|
|
305
|
+
export declare class ThrottlingException extends __BaseException {
|
|
306
|
+
readonly name: "ThrottlingException";
|
|
307
|
+
readonly $fault: "client";
|
|
308
|
+
$retryable: {};
|
|
309
|
+
xAmzErrorType?: string | undefined;
|
|
310
|
+
constructor(
|
|
311
|
+
opts: __ExceptionOptionType<ThrottlingException, __BaseException>
|
|
312
|
+
);
|
|
313
|
+
}
|
|
314
|
+
export declare class ValidationException extends __BaseException {
|
|
315
|
+
readonly name: "ValidationException";
|
|
316
|
+
readonly $fault: "client";
|
|
317
|
+
xAmzErrorType?: string | undefined;
|
|
318
|
+
constructor(
|
|
319
|
+
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
320
|
+
);
|
|
321
|
+
}
|
|
322
|
+
export interface DeleteCampaignRequest {
|
|
323
|
+
id: string | undefined;
|
|
324
|
+
}
|
|
325
|
+
export declare const ChannelSubtype: {
|
|
326
|
+
readonly EMAIL: "EMAIL";
|
|
327
|
+
readonly SMS: "SMS";
|
|
328
|
+
readonly TELEPHONY: "TELEPHONY";
|
|
329
|
+
};
|
|
330
|
+
export type ChannelSubtype =
|
|
331
|
+
(typeof ChannelSubtype)[keyof typeof ChannelSubtype];
|
|
332
|
+
export interface DeleteCampaignChannelSubtypeConfigRequest {
|
|
333
|
+
id: string | undefined;
|
|
334
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
335
|
+
}
|
|
336
|
+
export declare const CommunicationLimitsConfigType: {
|
|
337
|
+
readonly ALL_CHANNEL_SUBTYPES: "ALL_CHANNEL_SUBTYPES";
|
|
338
|
+
};
|
|
339
|
+
export type CommunicationLimitsConfigType =
|
|
340
|
+
(typeof CommunicationLimitsConfigType)[keyof typeof CommunicationLimitsConfigType];
|
|
341
|
+
export interface DeleteCampaignCommunicationLimitsRequest {
|
|
342
|
+
id: string | undefined;
|
|
343
|
+
config: CommunicationLimitsConfigType | undefined;
|
|
344
|
+
}
|
|
345
|
+
export declare const CampaignState: {
|
|
346
|
+
readonly COMPLETED: "Completed";
|
|
347
|
+
readonly FAILED: "Failed";
|
|
348
|
+
readonly INITIALIZED: "Initialized";
|
|
349
|
+
readonly PAUSED: "Paused";
|
|
350
|
+
readonly RUNNING: "Running";
|
|
351
|
+
readonly STOPPED: "Stopped";
|
|
352
|
+
};
|
|
353
|
+
export type CampaignState = (typeof CampaignState)[keyof typeof CampaignState];
|
|
354
|
+
export declare class InvalidCampaignStateException extends __BaseException {
|
|
355
|
+
readonly name: "InvalidCampaignStateException";
|
|
356
|
+
readonly $fault: "client";
|
|
357
|
+
state: CampaignState | undefined;
|
|
358
|
+
xAmzErrorType?: string | undefined;
|
|
359
|
+
constructor(
|
|
360
|
+
opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>
|
|
361
|
+
);
|
|
362
|
+
}
|
|
363
|
+
export declare const CommunicationTimeConfigType: {
|
|
364
|
+
readonly EMAIL: "EMAIL";
|
|
365
|
+
readonly SMS: "SMS";
|
|
366
|
+
readonly TELEPHONY: "TELEPHONY";
|
|
367
|
+
};
|
|
368
|
+
export type CommunicationTimeConfigType =
|
|
369
|
+
(typeof CommunicationTimeConfigType)[keyof typeof CommunicationTimeConfigType];
|
|
370
|
+
export interface DeleteCampaignCommunicationTimeRequest {
|
|
371
|
+
id: string | undefined;
|
|
372
|
+
config: CommunicationTimeConfigType | undefined;
|
|
373
|
+
}
|
|
374
|
+
export declare const CampaignDeletionPolicy: {
|
|
375
|
+
readonly DELETE_ALL: "DELETE_ALL";
|
|
376
|
+
readonly RETAIN_ALL: "RETAIN_ALL";
|
|
377
|
+
};
|
|
378
|
+
export type CampaignDeletionPolicy =
|
|
379
|
+
(typeof CampaignDeletionPolicy)[keyof typeof CampaignDeletionPolicy];
|
|
380
|
+
export interface DeleteConnectInstanceConfigRequest {
|
|
381
|
+
connectInstanceId: string | undefined;
|
|
382
|
+
campaignDeletionPolicy?: CampaignDeletionPolicy | undefined;
|
|
383
|
+
}
|
|
384
|
+
export declare class InvalidStateException extends __BaseException {
|
|
385
|
+
readonly name: "InvalidStateException";
|
|
386
|
+
readonly $fault: "client";
|
|
387
|
+
xAmzErrorType?: string | undefined;
|
|
388
|
+
constructor(
|
|
389
|
+
opts: __ExceptionOptionType<InvalidStateException, __BaseException>
|
|
390
|
+
);
|
|
391
|
+
}
|
|
392
|
+
export interface CustomerProfilesIntegrationIdentifier {
|
|
393
|
+
domainArn: string | undefined;
|
|
394
|
+
}
|
|
395
|
+
export interface QConnectIntegrationIdentifier {
|
|
396
|
+
knowledgeBaseArn: string | undefined;
|
|
397
|
+
}
|
|
398
|
+
export type IntegrationIdentifier =
|
|
399
|
+
| IntegrationIdentifier.CustomerProfilesMember
|
|
400
|
+
| IntegrationIdentifier.QConnectMember
|
|
401
|
+
| IntegrationIdentifier.$UnknownMember;
|
|
402
|
+
export declare namespace IntegrationIdentifier {
|
|
403
|
+
interface CustomerProfilesMember {
|
|
404
|
+
customerProfiles: CustomerProfilesIntegrationIdentifier;
|
|
405
|
+
qConnect?: never;
|
|
406
|
+
$unknown?: never;
|
|
407
|
+
}
|
|
408
|
+
interface QConnectMember {
|
|
409
|
+
customerProfiles?: never;
|
|
410
|
+
qConnect: QConnectIntegrationIdentifier;
|
|
411
|
+
$unknown?: never;
|
|
412
|
+
}
|
|
413
|
+
interface $UnknownMember {
|
|
414
|
+
customerProfiles?: never;
|
|
415
|
+
qConnect?: never;
|
|
416
|
+
$unknown: [string, any];
|
|
417
|
+
}
|
|
418
|
+
interface Visitor<T> {
|
|
419
|
+
customerProfiles: (value: CustomerProfilesIntegrationIdentifier) => T;
|
|
420
|
+
qConnect: (value: QConnectIntegrationIdentifier) => T;
|
|
421
|
+
_: (name: string, value: any) => T;
|
|
422
|
+
}
|
|
423
|
+
const visit: <T>(value: IntegrationIdentifier, visitor: Visitor<T>) => T;
|
|
424
|
+
}
|
|
425
|
+
export interface DeleteConnectInstanceIntegrationRequest {
|
|
426
|
+
connectInstanceId: string | undefined;
|
|
427
|
+
integrationIdentifier: IntegrationIdentifier | undefined;
|
|
428
|
+
}
|
|
429
|
+
export interface DeleteInstanceOnboardingJobRequest {
|
|
430
|
+
connectInstanceId: string | undefined;
|
|
431
|
+
}
|
|
432
|
+
export interface DescribeCampaignRequest {
|
|
433
|
+
id: string | undefined;
|
|
434
|
+
}
|
|
435
|
+
export interface Campaign {
|
|
436
|
+
id: string | undefined;
|
|
437
|
+
arn: string | undefined;
|
|
438
|
+
name: string | undefined;
|
|
439
|
+
connectInstanceId: string | undefined;
|
|
440
|
+
channelSubtypeConfig: ChannelSubtypeConfig | undefined;
|
|
441
|
+
source?: Source | undefined;
|
|
442
|
+
connectCampaignFlowArn?: string | undefined;
|
|
443
|
+
schedule?: Schedule | undefined;
|
|
444
|
+
communicationTimeConfig?: CommunicationTimeConfig | undefined;
|
|
445
|
+
communicationLimitsOverride?: CommunicationLimitsConfig | undefined;
|
|
446
|
+
tags?: Record<string, string> | undefined;
|
|
447
|
+
}
|
|
448
|
+
export interface DescribeCampaignResponse {
|
|
449
|
+
campaign?: Campaign | undefined;
|
|
450
|
+
}
|
|
451
|
+
export interface GetCampaignStateRequest {
|
|
452
|
+
id: string | undefined;
|
|
453
|
+
}
|
|
454
|
+
export interface GetCampaignStateResponse {
|
|
455
|
+
state?: CampaignState | undefined;
|
|
456
|
+
}
|
|
457
|
+
export interface GetCampaignStateBatchRequest {
|
|
458
|
+
campaignIds: string[] | undefined;
|
|
459
|
+
}
|
|
460
|
+
export declare const GetCampaignStateBatchFailureCode: {
|
|
461
|
+
readonly RESOURCE_NOT_FOUND: "ResourceNotFound";
|
|
462
|
+
readonly UNKNOWN_ERROR: "UnknownError";
|
|
463
|
+
};
|
|
464
|
+
export type GetCampaignStateBatchFailureCode =
|
|
465
|
+
(typeof GetCampaignStateBatchFailureCode)[keyof typeof GetCampaignStateBatchFailureCode];
|
|
466
|
+
export interface FailedCampaignStateResponse {
|
|
467
|
+
campaignId?: string | undefined;
|
|
468
|
+
failureCode?: GetCampaignStateBatchFailureCode | undefined;
|
|
469
|
+
}
|
|
470
|
+
export interface SuccessfulCampaignStateResponse {
|
|
471
|
+
campaignId?: string | undefined;
|
|
472
|
+
state?: CampaignState | undefined;
|
|
473
|
+
}
|
|
474
|
+
export interface GetCampaignStateBatchResponse {
|
|
475
|
+
successfulRequests?: SuccessfulCampaignStateResponse[] | undefined;
|
|
476
|
+
failedRequests?: FailedCampaignStateResponse[] | undefined;
|
|
477
|
+
}
|
|
478
|
+
export interface GetConnectInstanceConfigRequest {
|
|
479
|
+
connectInstanceId: string | undefined;
|
|
480
|
+
}
|
|
481
|
+
export declare const EncryptionType: {
|
|
482
|
+
readonly KMS: "KMS";
|
|
483
|
+
};
|
|
484
|
+
export type EncryptionType =
|
|
485
|
+
(typeof EncryptionType)[keyof typeof EncryptionType];
|
|
486
|
+
export interface EncryptionConfig {
|
|
487
|
+
enabled: boolean | undefined;
|
|
488
|
+
encryptionType?: EncryptionType | undefined;
|
|
489
|
+
keyArn?: string | undefined;
|
|
490
|
+
}
|
|
491
|
+
export interface InstanceConfig {
|
|
492
|
+
connectInstanceId: string | undefined;
|
|
493
|
+
serviceLinkedRoleArn: string | undefined;
|
|
494
|
+
encryptionConfig: EncryptionConfig | undefined;
|
|
495
|
+
}
|
|
496
|
+
export interface GetConnectInstanceConfigResponse {
|
|
497
|
+
connectInstanceConfig?: InstanceConfig | undefined;
|
|
498
|
+
}
|
|
499
|
+
export interface GetInstanceOnboardingJobStatusRequest {
|
|
500
|
+
connectInstanceId: string | undefined;
|
|
501
|
+
}
|
|
502
|
+
export declare const InstanceOnboardingJobFailureCode: {
|
|
503
|
+
readonly EVENT_BRIDGE_ACCESS_DENIED: "EVENT_BRIDGE_ACCESS_DENIED";
|
|
504
|
+
readonly EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED: "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED";
|
|
505
|
+
readonly IAM_ACCESS_DENIED: "IAM_ACCESS_DENIED";
|
|
506
|
+
readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
|
|
507
|
+
readonly KMS_ACCESS_DENIED: "KMS_ACCESS_DENIED";
|
|
508
|
+
readonly KMS_KEY_NOT_FOUND: "KMS_KEY_NOT_FOUND";
|
|
509
|
+
};
|
|
510
|
+
export type InstanceOnboardingJobFailureCode =
|
|
511
|
+
(typeof InstanceOnboardingJobFailureCode)[keyof typeof InstanceOnboardingJobFailureCode];
|
|
512
|
+
export declare const InstanceOnboardingJobStatusCode: {
|
|
513
|
+
readonly FAILED: "FAILED";
|
|
514
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
515
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
516
|
+
};
|
|
517
|
+
export type InstanceOnboardingJobStatusCode =
|
|
518
|
+
(typeof InstanceOnboardingJobStatusCode)[keyof typeof InstanceOnboardingJobStatusCode];
|
|
519
|
+
export interface InstanceOnboardingJobStatus {
|
|
520
|
+
connectInstanceId: string | undefined;
|
|
521
|
+
status: InstanceOnboardingJobStatusCode | undefined;
|
|
522
|
+
failureCode?: InstanceOnboardingJobFailureCode | undefined;
|
|
523
|
+
}
|
|
524
|
+
export interface GetInstanceOnboardingJobStatusResponse {
|
|
525
|
+
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus | undefined;
|
|
526
|
+
}
|
|
527
|
+
export declare const InstanceIdFilterOperator: {
|
|
528
|
+
readonly EQ: "Eq";
|
|
529
|
+
};
|
|
530
|
+
export type InstanceIdFilterOperator =
|
|
531
|
+
(typeof InstanceIdFilterOperator)[keyof typeof InstanceIdFilterOperator];
|
|
532
|
+
export interface InstanceIdFilter {
|
|
533
|
+
value: string | undefined;
|
|
534
|
+
operator: InstanceIdFilterOperator | undefined;
|
|
535
|
+
}
|
|
536
|
+
export interface CampaignFilters {
|
|
537
|
+
instanceIdFilter?: InstanceIdFilter | undefined;
|
|
538
|
+
}
|
|
539
|
+
export interface ListCampaignsRequest {
|
|
540
|
+
maxResults?: number | undefined;
|
|
541
|
+
nextToken?: string | undefined;
|
|
542
|
+
filters?: CampaignFilters | undefined;
|
|
543
|
+
}
|
|
544
|
+
export interface CampaignSummary {
|
|
545
|
+
id: string | undefined;
|
|
546
|
+
arn: string | undefined;
|
|
547
|
+
name: string | undefined;
|
|
548
|
+
connectInstanceId: string | undefined;
|
|
549
|
+
channelSubtypes: ChannelSubtype[] | undefined;
|
|
550
|
+
schedule?: Schedule | undefined;
|
|
551
|
+
connectCampaignFlowArn?: string | undefined;
|
|
552
|
+
}
|
|
553
|
+
export interface ListCampaignsResponse {
|
|
554
|
+
nextToken?: string | undefined;
|
|
555
|
+
campaignSummaryList?: CampaignSummary[] | undefined;
|
|
556
|
+
}
|
|
557
|
+
export interface ListConnectInstanceIntegrationsRequest {
|
|
558
|
+
connectInstanceId: string | undefined;
|
|
559
|
+
maxResults?: number | undefined;
|
|
560
|
+
nextToken?: string | undefined;
|
|
561
|
+
}
|
|
562
|
+
export declare const EventType: {
|
|
563
|
+
readonly CAMPAIGN_EMAIL: "Campaign-Email";
|
|
564
|
+
readonly CAMPAIGN_ORCHESTRATION: "Campaign-Orchestration";
|
|
565
|
+
readonly CAMPAIGN_SMS: "Campaign-SMS";
|
|
566
|
+
readonly CAMPAIGN_TELEPHONY: "Campaign-Telephony";
|
|
567
|
+
};
|
|
568
|
+
export type EventType = (typeof EventType)[keyof typeof EventType];
|
|
569
|
+
export interface CustomerProfilesIntegrationSummary {
|
|
570
|
+
domainArn: string | undefined;
|
|
571
|
+
objectTypeNames: Partial<Record<EventType, string>> | undefined;
|
|
572
|
+
}
|
|
573
|
+
export interface QConnectIntegrationSummary {
|
|
574
|
+
knowledgeBaseArn: string | undefined;
|
|
575
|
+
}
|
|
576
|
+
export type IntegrationSummary =
|
|
577
|
+
| IntegrationSummary.CustomerProfilesMember
|
|
578
|
+
| IntegrationSummary.QConnectMember
|
|
579
|
+
| IntegrationSummary.$UnknownMember;
|
|
580
|
+
export declare namespace IntegrationSummary {
|
|
581
|
+
interface CustomerProfilesMember {
|
|
582
|
+
customerProfiles: CustomerProfilesIntegrationSummary;
|
|
583
|
+
qConnect?: never;
|
|
584
|
+
$unknown?: never;
|
|
585
|
+
}
|
|
586
|
+
interface QConnectMember {
|
|
587
|
+
customerProfiles?: never;
|
|
588
|
+
qConnect: QConnectIntegrationSummary;
|
|
589
|
+
$unknown?: never;
|
|
590
|
+
}
|
|
591
|
+
interface $UnknownMember {
|
|
592
|
+
customerProfiles?: never;
|
|
593
|
+
qConnect?: never;
|
|
594
|
+
$unknown: [string, any];
|
|
595
|
+
}
|
|
596
|
+
interface Visitor<T> {
|
|
597
|
+
customerProfiles: (value: CustomerProfilesIntegrationSummary) => T;
|
|
598
|
+
qConnect: (value: QConnectIntegrationSummary) => T;
|
|
599
|
+
_: (name: string, value: any) => T;
|
|
600
|
+
}
|
|
601
|
+
const visit: <T>(value: IntegrationSummary, visitor: Visitor<T>) => T;
|
|
602
|
+
}
|
|
603
|
+
export interface ListConnectInstanceIntegrationsResponse {
|
|
604
|
+
nextToken?: string | undefined;
|
|
605
|
+
integrationSummaryList?: IntegrationSummary[] | undefined;
|
|
606
|
+
}
|
|
607
|
+
export interface ListTagsForResourceRequest {
|
|
608
|
+
arn: string | undefined;
|
|
609
|
+
}
|
|
610
|
+
export interface ListTagsForResourceResponse {
|
|
611
|
+
tags?: Record<string, string> | undefined;
|
|
612
|
+
}
|
|
613
|
+
export interface PauseCampaignRequest {
|
|
614
|
+
id: string | undefined;
|
|
615
|
+
}
|
|
616
|
+
export interface CustomerProfilesIntegrationConfig {
|
|
617
|
+
domainArn: string | undefined;
|
|
618
|
+
objectTypeNames: Partial<Record<EventType, string>> | undefined;
|
|
619
|
+
}
|
|
620
|
+
export interface QConnectIntegrationConfig {
|
|
621
|
+
knowledgeBaseArn: string | undefined;
|
|
622
|
+
}
|
|
623
|
+
export type IntegrationConfig =
|
|
624
|
+
| IntegrationConfig.CustomerProfilesMember
|
|
625
|
+
| IntegrationConfig.QConnectMember
|
|
626
|
+
| IntegrationConfig.$UnknownMember;
|
|
627
|
+
export declare namespace IntegrationConfig {
|
|
628
|
+
interface CustomerProfilesMember {
|
|
629
|
+
customerProfiles: CustomerProfilesIntegrationConfig;
|
|
630
|
+
qConnect?: never;
|
|
631
|
+
$unknown?: never;
|
|
632
|
+
}
|
|
633
|
+
interface QConnectMember {
|
|
634
|
+
customerProfiles?: never;
|
|
635
|
+
qConnect: QConnectIntegrationConfig;
|
|
636
|
+
$unknown?: never;
|
|
637
|
+
}
|
|
638
|
+
interface $UnknownMember {
|
|
639
|
+
customerProfiles?: never;
|
|
640
|
+
qConnect?: never;
|
|
641
|
+
$unknown: [string, any];
|
|
642
|
+
}
|
|
643
|
+
interface Visitor<T> {
|
|
644
|
+
customerProfiles: (value: CustomerProfilesIntegrationConfig) => T;
|
|
645
|
+
qConnect: (value: QConnectIntegrationConfig) => T;
|
|
646
|
+
_: (name: string, value: any) => T;
|
|
647
|
+
}
|
|
648
|
+
const visit: <T>(value: IntegrationConfig, visitor: Visitor<T>) => T;
|
|
649
|
+
}
|
|
650
|
+
export interface PutConnectInstanceIntegrationRequest {
|
|
651
|
+
connectInstanceId: string | undefined;
|
|
652
|
+
integrationConfig: IntegrationConfig | undefined;
|
|
653
|
+
}
|
|
654
|
+
export interface EmailChannelSubtypeParameters {
|
|
655
|
+
destinationEmailAddress: string | undefined;
|
|
656
|
+
connectSourceEmailAddress?: string | undefined;
|
|
657
|
+
templateArn?: string | undefined;
|
|
658
|
+
templateParameters: Record<string, string> | undefined;
|
|
659
|
+
}
|
|
660
|
+
export interface SmsChannelSubtypeParameters {
|
|
661
|
+
destinationPhoneNumber: string | undefined;
|
|
662
|
+
connectSourcePhoneNumberArn?: string | undefined;
|
|
663
|
+
templateArn?: string | undefined;
|
|
664
|
+
templateParameters: Record<string, string> | undefined;
|
|
665
|
+
}
|
|
666
|
+
export interface TelephonyChannelSubtypeParameters {
|
|
667
|
+
destinationPhoneNumber: string | undefined;
|
|
668
|
+
attributes: Record<string, string> | undefined;
|
|
669
|
+
connectSourcePhoneNumber?: string | undefined;
|
|
670
|
+
answerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined;
|
|
671
|
+
}
|
|
672
|
+
export type ChannelSubtypeParameters =
|
|
673
|
+
| ChannelSubtypeParameters.EmailMember
|
|
674
|
+
| ChannelSubtypeParameters.SmsMember
|
|
675
|
+
| ChannelSubtypeParameters.TelephonyMember
|
|
676
|
+
| ChannelSubtypeParameters.$UnknownMember;
|
|
677
|
+
export declare namespace ChannelSubtypeParameters {
|
|
678
|
+
interface TelephonyMember {
|
|
679
|
+
telephony: TelephonyChannelSubtypeParameters;
|
|
680
|
+
sms?: never;
|
|
681
|
+
email?: never;
|
|
682
|
+
$unknown?: never;
|
|
683
|
+
}
|
|
684
|
+
interface SmsMember {
|
|
685
|
+
telephony?: never;
|
|
686
|
+
sms: SmsChannelSubtypeParameters;
|
|
687
|
+
email?: never;
|
|
688
|
+
$unknown?: never;
|
|
689
|
+
}
|
|
690
|
+
interface EmailMember {
|
|
691
|
+
telephony?: never;
|
|
692
|
+
sms?: never;
|
|
693
|
+
email: EmailChannelSubtypeParameters;
|
|
694
|
+
$unknown?: never;
|
|
695
|
+
}
|
|
696
|
+
interface $UnknownMember {
|
|
697
|
+
telephony?: never;
|
|
698
|
+
sms?: never;
|
|
699
|
+
email?: never;
|
|
700
|
+
$unknown: [string, any];
|
|
701
|
+
}
|
|
702
|
+
interface Visitor<T> {
|
|
703
|
+
telephony: (value: TelephonyChannelSubtypeParameters) => T;
|
|
704
|
+
sms: (value: SmsChannelSubtypeParameters) => T;
|
|
705
|
+
email: (value: EmailChannelSubtypeParameters) => T;
|
|
706
|
+
_: (name: string, value: any) => T;
|
|
707
|
+
}
|
|
708
|
+
const visit: <T>(value: ChannelSubtypeParameters, visitor: Visitor<T>) => T;
|
|
709
|
+
}
|
|
710
|
+
export interface OutboundRequest {
|
|
711
|
+
clientToken: string | undefined;
|
|
712
|
+
expirationTime: Date | undefined;
|
|
713
|
+
channelSubtypeParameters: ChannelSubtypeParameters | undefined;
|
|
714
|
+
}
|
|
715
|
+
export interface PutOutboundRequestBatchRequest {
|
|
716
|
+
id: string | undefined;
|
|
717
|
+
outboundRequests: OutboundRequest[] | undefined;
|
|
718
|
+
}
|
|
719
|
+
export declare const FailureCode: {
|
|
720
|
+
readonly BUFFER_LIMIT_EXCEEDED: "BufferLimitExceeded";
|
|
721
|
+
readonly INVALID_INPUT: "InvalidInput";
|
|
722
|
+
readonly REQUEST_THROTTLED: "RequestThrottled";
|
|
723
|
+
readonly UNKNOWN_ERROR: "UnknownError";
|
|
724
|
+
};
|
|
725
|
+
export type FailureCode = (typeof FailureCode)[keyof typeof FailureCode];
|
|
726
|
+
export interface FailedRequest {
|
|
727
|
+
clientToken?: string | undefined;
|
|
728
|
+
id?: string | undefined;
|
|
729
|
+
failureCode?: FailureCode | undefined;
|
|
730
|
+
}
|
|
731
|
+
export interface SuccessfulRequest {
|
|
732
|
+
clientToken?: string | undefined;
|
|
733
|
+
id?: string | undefined;
|
|
734
|
+
}
|
|
735
|
+
export interface PutOutboundRequestBatchResponse {
|
|
736
|
+
successfulRequests?: SuccessfulRequest[] | undefined;
|
|
737
|
+
failedRequests?: FailedRequest[] | undefined;
|
|
738
|
+
}
|
|
739
|
+
export interface ResumeCampaignRequest {
|
|
740
|
+
id: string | undefined;
|
|
741
|
+
}
|
|
742
|
+
export interface StartCampaignRequest {
|
|
743
|
+
id: string | undefined;
|
|
744
|
+
}
|
|
745
|
+
export interface StartInstanceOnboardingJobRequest {
|
|
746
|
+
connectInstanceId: string | undefined;
|
|
747
|
+
encryptionConfig: EncryptionConfig | undefined;
|
|
748
|
+
}
|
|
749
|
+
export interface StartInstanceOnboardingJobResponse {
|
|
750
|
+
connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus | undefined;
|
|
751
|
+
}
|
|
752
|
+
export interface StopCampaignRequest {
|
|
753
|
+
id: string | undefined;
|
|
754
|
+
}
|
|
755
|
+
export interface TagResourceRequest {
|
|
756
|
+
arn: string | undefined;
|
|
757
|
+
tags: Record<string, string> | undefined;
|
|
758
|
+
}
|
|
759
|
+
export interface UntagResourceRequest {
|
|
760
|
+
arn: string | undefined;
|
|
761
|
+
tagKeys: string[] | undefined;
|
|
762
|
+
}
|
|
763
|
+
export interface UpdateCampaignChannelSubtypeConfigRequest {
|
|
764
|
+
id: string | undefined;
|
|
765
|
+
channelSubtypeConfig: ChannelSubtypeConfig | undefined;
|
|
766
|
+
}
|
|
767
|
+
export interface UpdateCampaignCommunicationLimitsRequest {
|
|
768
|
+
id: string | undefined;
|
|
769
|
+
communicationLimitsOverride: CommunicationLimitsConfig | undefined;
|
|
770
|
+
}
|
|
771
|
+
export interface UpdateCampaignCommunicationTimeRequest {
|
|
772
|
+
id: string | undefined;
|
|
773
|
+
communicationTimeConfig: CommunicationTimeConfig | undefined;
|
|
774
|
+
}
|
|
775
|
+
export interface UpdateCampaignFlowAssociationRequest {
|
|
776
|
+
id: string | undefined;
|
|
777
|
+
connectCampaignFlowArn: string | undefined;
|
|
778
|
+
}
|
|
779
|
+
export interface UpdateCampaignNameRequest {
|
|
780
|
+
id: string | undefined;
|
|
781
|
+
name: string | undefined;
|
|
782
|
+
}
|
|
783
|
+
export interface UpdateCampaignScheduleRequest {
|
|
784
|
+
id: string | undefined;
|
|
785
|
+
schedule: Schedule | undefined;
|
|
786
|
+
}
|
|
787
|
+
export interface UpdateCampaignSourceRequest {
|
|
788
|
+
id: string | undefined;
|
|
789
|
+
source: Source | undefined;
|
|
790
|
+
}
|
|
791
|
+
export declare const EmailOutboundConfigFilterSensitiveLog: (
|
|
792
|
+
obj: EmailOutboundConfig
|
|
793
|
+
) => any;
|
|
794
|
+
export declare const EmailChannelSubtypeConfigFilterSensitiveLog: (
|
|
795
|
+
obj: EmailChannelSubtypeConfig
|
|
796
|
+
) => any;
|
|
797
|
+
export declare const ChannelSubtypeConfigFilterSensitiveLog: (
|
|
798
|
+
obj: ChannelSubtypeConfig
|
|
799
|
+
) => any;
|
|
800
|
+
export declare const CreateCampaignRequestFilterSensitiveLog: (
|
|
801
|
+
obj: CreateCampaignRequest
|
|
802
|
+
) => any;
|
|
803
|
+
export declare const CampaignFilterSensitiveLog: (obj: Campaign) => any;
|
|
804
|
+
export declare const DescribeCampaignResponseFilterSensitiveLog: (
|
|
805
|
+
obj: DescribeCampaignResponse
|
|
806
|
+
) => any;
|
|
807
|
+
export declare const EmailChannelSubtypeParametersFilterSensitiveLog: (
|
|
808
|
+
obj: EmailChannelSubtypeParameters
|
|
809
|
+
) => any;
|
|
810
|
+
export declare const SmsChannelSubtypeParametersFilterSensitiveLog: (
|
|
811
|
+
obj: SmsChannelSubtypeParameters
|
|
812
|
+
) => any;
|
|
813
|
+
export declare const TelephonyChannelSubtypeParametersFilterSensitiveLog: (
|
|
814
|
+
obj: TelephonyChannelSubtypeParameters
|
|
815
|
+
) => any;
|
|
816
|
+
export declare const ChannelSubtypeParametersFilterSensitiveLog: (
|
|
817
|
+
obj: ChannelSubtypeParameters
|
|
818
|
+
) => any;
|
|
819
|
+
export declare const OutboundRequestFilterSensitiveLog: (
|
|
820
|
+
obj: OutboundRequest
|
|
821
|
+
) => any;
|
|
822
|
+
export declare const PutOutboundRequestBatchRequestFilterSensitiveLog: (
|
|
823
|
+
obj: PutOutboundRequestBatchRequest
|
|
824
|
+
) => any;
|
|
825
|
+
export declare const UpdateCampaignChannelSubtypeConfigRequestFilterSensitiveLog: (
|
|
826
|
+
obj: UpdateCampaignChannelSubtypeConfigRequest
|
|
827
|
+
) => any;
|