@aws-sdk/client-connectcampaigns 3.113.0

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

@@ -0,0 +1,691 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { ConnectCampaignsServiceException as __BaseException } from "./ConnectCampaignsServiceException";
+
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+
+export interface PredictiveDialerConfig {
+    
+    bandwidthAllocation: number | undefined;
+}
+export declare namespace PredictiveDialerConfig {
+    
+    const filterSensitiveLog: (obj: PredictiveDialerConfig) => any;
+}
+
+export interface ProgressiveDialerConfig {
+    
+    bandwidthAllocation: number | undefined;
+}
+export declare namespace ProgressiveDialerConfig {
+    
+    const filterSensitiveLog: (obj: ProgressiveDialerConfig) => any;
+}
+
+export declare type DialerConfig = DialerConfig.PredictiveDialerConfigMember | DialerConfig.ProgressiveDialerConfigMember | DialerConfig.$UnknownMember;
+export declare namespace DialerConfig {
+    
+    interface ProgressiveDialerConfigMember {
+        progressiveDialerConfig: ProgressiveDialerConfig;
+        predictiveDialerConfig?: never;
+        $unknown?: never;
+    }
+    
+    interface PredictiveDialerConfigMember {
+        progressiveDialerConfig?: never;
+        predictiveDialerConfig: PredictiveDialerConfig;
+        $unknown?: never;
+    }
+    interface $UnknownMember {
+        progressiveDialerConfig?: never;
+        predictiveDialerConfig?: never;
+        $unknown: [
+            string,
+            any
+        ];
+    }
+    interface Visitor<T> {
+        progressiveDialerConfig: (value: ProgressiveDialerConfig) => T;
+        predictiveDialerConfig: (value: PredictiveDialerConfig) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: DialerConfig, visitor: Visitor<T>) => T;
+    
+    const filterSensitiveLog: (obj: DialerConfig) => any;
+}
+
+export interface AnswerMachineDetectionConfig {
+    
+    enableAnswerMachineDetection: boolean | undefined;
+}
+export declare namespace AnswerMachineDetectionConfig {
+    
+    const filterSensitiveLog: (obj: AnswerMachineDetectionConfig) => any;
+}
+
+export interface OutboundCallConfig {
+    
+    connectContactFlowId: string | undefined;
+    
+    connectSourcePhoneNumber?: string;
+    
+    connectQueueId: string | undefined;
+    
+    answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
+}
+export declare namespace OutboundCallConfig {
+    
+    const filterSensitiveLog: (obj: OutboundCallConfig) => any;
+}
+
+export interface CreateCampaignRequest {
+    
+    name: string | undefined;
+    
+    connectInstanceId: string | undefined;
+    
+    dialerConfig: DialerConfig | undefined;
+    
+    outboundCallConfig: OutboundCallConfig | undefined;
+    
+    tags?: Record<string, string>;
+}
+export declare namespace CreateCampaignRequest {
+    
+    const filterSensitiveLog: (obj: CreateCampaignRequest) => any;
+}
+
+export interface CreateCampaignResponse {
+    
+    id?: string;
+    
+    arn?: string;
+    
+    tags?: Record<string, string>;
+}
+export declare namespace CreateCampaignResponse {
+    
+    const filterSensitiveLog: (obj: CreateCampaignResponse) => any;
+}
+
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    $retryable: {};
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {};
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+
+export interface DeleteCampaignRequest {
+    
+    id: string | undefined;
+}
+export declare namespace DeleteCampaignRequest {
+    
+    const filterSensitiveLog: (obj: DeleteCampaignRequest) => any;
+}
+
+export interface DeleteConnectInstanceConfigRequest {
+    
+    connectInstanceId: string | undefined;
+}
+export declare namespace DeleteConnectInstanceConfigRequest {
+    
+    const filterSensitiveLog: (obj: DeleteConnectInstanceConfigRequest) => any;
+}
+
+export declare class InvalidStateException extends __BaseException {
+    readonly name: "InvalidStateException";
+    readonly $fault: "client";
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<InvalidStateException, __BaseException>);
+}
+
+export interface DeleteInstanceOnboardingJobRequest {
+    
+    connectInstanceId: string | undefined;
+}
+export declare namespace DeleteInstanceOnboardingJobRequest {
+    
+    const filterSensitiveLog: (obj: DeleteInstanceOnboardingJobRequest) => any;
+}
+
+export interface DescribeCampaignRequest {
+    
+    id: string | undefined;
+}
+export declare namespace DescribeCampaignRequest {
+    
+    const filterSensitiveLog: (obj: DescribeCampaignRequest) => any;
+}
+
+export interface Campaign {
+    
+    id: string | undefined;
+    
+    arn: string | undefined;
+    
+    name: string | undefined;
+    
+    connectInstanceId: string | undefined;
+    
+    dialerConfig: DialerConfig | undefined;
+    
+    outboundCallConfig: OutboundCallConfig | undefined;
+    
+    tags?: Record<string, string>;
+}
+export declare namespace Campaign {
+    
+    const filterSensitiveLog: (obj: Campaign) => any;
+}
+
+export interface DescribeCampaignResponse {
+    
+    campaign?: Campaign;
+}
+export declare namespace DescribeCampaignResponse {
+    
+    const filterSensitiveLog: (obj: DescribeCampaignResponse) => any;
+}
+
+export interface GetCampaignStateRequest {
+    
+    id: string | undefined;
+}
+export declare namespace GetCampaignStateRequest {
+    
+    const filterSensitiveLog: (obj: GetCampaignStateRequest) => any;
+}
+export declare enum CampaignState {
+    
+    FAILED = "Failed",
+    
+    INITIALIZED = "Initialized",
+    
+    PAUSED = "Paused",
+    
+    RUNNING = "Running",
+    
+    STOPPED = "Stopped"
+}
+
+export interface GetCampaignStateResponse {
+    
+    state?: CampaignState | string;
+}
+export declare namespace GetCampaignStateResponse {
+    
+    const filterSensitiveLog: (obj: GetCampaignStateResponse) => any;
+}
+
+export interface GetCampaignStateBatchRequest {
+    
+    campaignIds: string[] | undefined;
+}
+export declare namespace GetCampaignStateBatchRequest {
+    
+    const filterSensitiveLog: (obj: GetCampaignStateBatchRequest) => any;
+}
+export declare enum GetCampaignStateBatchFailureCode {
+    
+    RESOURCE_NOT_FOUND = "ResourceNotFound",
+    
+    UNKNOWN_ERROR = "UnknownError"
+}
+
+export interface FailedCampaignStateResponse {
+    
+    campaignId?: string;
+    
+    failureCode?: GetCampaignStateBatchFailureCode | string;
+}
+export declare namespace FailedCampaignStateResponse {
+    
+    const filterSensitiveLog: (obj: FailedCampaignStateResponse) => any;
+}
+
+export interface SuccessfulCampaignStateResponse {
+    
+    campaignId?: string;
+    
+    state?: CampaignState | string;
+}
+export declare namespace SuccessfulCampaignStateResponse {
+    
+    const filterSensitiveLog: (obj: SuccessfulCampaignStateResponse) => any;
+}
+
+export interface GetCampaignStateBatchResponse {
+    
+    successfulRequests?: SuccessfulCampaignStateResponse[];
+    
+    failedRequests?: FailedCampaignStateResponse[];
+}
+export declare namespace GetCampaignStateBatchResponse {
+    
+    const filterSensitiveLog: (obj: GetCampaignStateBatchResponse) => any;
+}
+
+export interface GetConnectInstanceConfigRequest {
+    
+    connectInstanceId: string | undefined;
+}
+export declare namespace GetConnectInstanceConfigRequest {
+    
+    const filterSensitiveLog: (obj: GetConnectInstanceConfigRequest) => any;
+}
+export declare enum EncryptionType {
+    KMS = "KMS"
+}
+
+export interface EncryptionConfig {
+    
+    enabled: boolean | undefined;
+    
+    encryptionType?: EncryptionType | string;
+    
+    keyArn?: string;
+}
+export declare namespace EncryptionConfig {
+    
+    const filterSensitiveLog: (obj: EncryptionConfig) => any;
+}
+
+export interface InstanceConfig {
+    
+    connectInstanceId: string | undefined;
+    
+    serviceLinkedRoleArn: string | undefined;
+    
+    encryptionConfig: EncryptionConfig | undefined;
+}
+export declare namespace InstanceConfig {
+    
+    const filterSensitiveLog: (obj: InstanceConfig) => any;
+}
+
+export interface GetConnectInstanceConfigResponse {
+    
+    connectInstanceConfig?: InstanceConfig;
+}
+export declare namespace GetConnectInstanceConfigResponse {
+    
+    const filterSensitiveLog: (obj: GetConnectInstanceConfigResponse) => any;
+}
+
+export interface GetInstanceOnboardingJobStatusRequest {
+    
+    connectInstanceId: string | undefined;
+}
+export declare namespace GetInstanceOnboardingJobStatusRequest {
+    
+    const filterSensitiveLog: (obj: GetInstanceOnboardingJobStatusRequest) => any;
+}
+export declare enum InstanceOnboardingJobFailureCode {
+    EVENT_BRIDGE_ACCESS_DENIED = "EVENT_BRIDGE_ACCESS_DENIED",
+    EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED = "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED",
+    IAM_ACCESS_DENIED = "IAM_ACCESS_DENIED",
+    INTERNAL_FAILURE = "INTERNAL_FAILURE",
+    KMS_ACCESS_DENIED = "KMS_ACCESS_DENIED",
+    KMS_KEY_NOT_FOUND = "KMS_KEY_NOT_FOUND"
+}
+export declare enum InstanceOnboardingJobStatusCode {
+    FAILED = "FAILED",
+    IN_PROGRESS = "IN_PROGRESS",
+    SUCCEEDED = "SUCCEEDED"
+}
+
+export interface InstanceOnboardingJobStatus {
+    
+    connectInstanceId: string | undefined;
+    
+    status: InstanceOnboardingJobStatusCode | string | undefined;
+    
+    failureCode?: InstanceOnboardingJobFailureCode | string;
+}
+export declare namespace InstanceOnboardingJobStatus {
+    
+    const filterSensitiveLog: (obj: InstanceOnboardingJobStatus) => any;
+}
+
+export interface GetInstanceOnboardingJobStatusResponse {
+    
+    connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
+}
+export declare namespace GetInstanceOnboardingJobStatusResponse {
+    
+    const filterSensitiveLog: (obj: GetInstanceOnboardingJobStatusResponse) => any;
+}
+export declare enum InstanceIdFilterOperator {
+    
+    EQ = "Eq"
+}
+
+export interface InstanceIdFilter {
+    
+    value: string | undefined;
+    
+    operator: InstanceIdFilterOperator | string | undefined;
+}
+export declare namespace InstanceIdFilter {
+    
+    const filterSensitiveLog: (obj: InstanceIdFilter) => any;
+}
+
+export interface CampaignFilters {
+    
+    instanceIdFilter?: InstanceIdFilter;
+}
+export declare namespace CampaignFilters {
+    
+    const filterSensitiveLog: (obj: CampaignFilters) => any;
+}
+
+export interface ListCampaignsRequest {
+    
+    maxResults?: number;
+    
+    nextToken?: string;
+    
+    filters?: CampaignFilters;
+}
+export declare namespace ListCampaignsRequest {
+    
+    const filterSensitiveLog: (obj: ListCampaignsRequest) => any;
+}
+
+export interface CampaignSummary {
+    
+    id: string | undefined;
+    
+    arn: string | undefined;
+    
+    name: string | undefined;
+    
+    connectInstanceId: string | undefined;
+}
+export declare namespace CampaignSummary {
+    
+    const filterSensitiveLog: (obj: CampaignSummary) => any;
+}
+
+export interface ListCampaignsResponse {
+    
+    nextToken?: string;
+    
+    campaignSummaryList?: CampaignSummary[];
+}
+export declare namespace ListCampaignsResponse {
+    
+    const filterSensitiveLog: (obj: ListCampaignsResponse) => any;
+}
+
+export interface ListTagsForResourceRequest {
+    
+    arn: string | undefined;
+}
+export declare namespace ListTagsForResourceRequest {
+    
+    const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
+}
+
+export interface ListTagsForResourceResponse {
+    
+    tags?: Record<string, string>;
+}
+export declare namespace ListTagsForResourceResponse {
+    
+    const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
+}
+
+export declare class InvalidCampaignStateException extends __BaseException {
+    readonly name: "InvalidCampaignStateException";
+    readonly $fault: "client";
+    
+    state: CampaignState | string | undefined;
+    
+    xAmzErrorType?: string;
+    
+    constructor(opts: __ExceptionOptionType<InvalidCampaignStateException, __BaseException>);
+}
+
+export interface PauseCampaignRequest {
+    
+    id: string | undefined;
+}
+export declare namespace PauseCampaignRequest {
+    
+    const filterSensitiveLog: (obj: PauseCampaignRequest) => any;
+}
+
+export interface DialRequest {
+    
+    clientToken: string | undefined;
+    
+    phoneNumber: string | undefined;
+    
+    expirationTime: Date | undefined;
+    
+    attributes: Record<string, string> | undefined;
+}
+export declare namespace DialRequest {
+    
+    const filterSensitiveLog: (obj: DialRequest) => any;
+}
+
+export interface PutDialRequestBatchRequest {
+    
+    id: string | undefined;
+    
+    dialRequests: DialRequest[] | undefined;
+}
+export declare namespace PutDialRequestBatchRequest {
+    
+    const filterSensitiveLog: (obj: PutDialRequestBatchRequest) => any;
+}
+export declare enum FailureCode {
+    
+    INVALID_INPUT = "InvalidInput",
+    
+    REQUEST_THROTTLED = "RequestThrottled",
+    
+    UNKNOWN_ERROR = "UnknownError"
+}
+
+export interface FailedRequest {
+    
+    clientToken?: string;
+    
+    id?: string;
+    
+    failureCode?: FailureCode | string;
+}
+export declare namespace FailedRequest {
+    
+    const filterSensitiveLog: (obj: FailedRequest) => any;
+}
+
+export interface SuccessfulRequest {
+    
+    clientToken?: string;
+    
+    id?: string;
+}
+export declare namespace SuccessfulRequest {
+    
+    const filterSensitiveLog: (obj: SuccessfulRequest) => any;
+}
+
+export interface PutDialRequestBatchResponse {
+    
+    successfulRequests?: SuccessfulRequest[];
+    
+    failedRequests?: FailedRequest[];
+}
+export declare namespace PutDialRequestBatchResponse {
+    
+    const filterSensitiveLog: (obj: PutDialRequestBatchResponse) => any;
+}
+
+export interface ResumeCampaignRequest {
+    
+    id: string | undefined;
+}
+export declare namespace ResumeCampaignRequest {
+    
+    const filterSensitiveLog: (obj: ResumeCampaignRequest) => any;
+}
+
+export interface StartCampaignRequest {
+    
+    id: string | undefined;
+}
+export declare namespace StartCampaignRequest {
+    
+    const filterSensitiveLog: (obj: StartCampaignRequest) => any;
+}
+
+export interface StartInstanceOnboardingJobRequest {
+    
+    connectInstanceId: string | undefined;
+    
+    encryptionConfig: EncryptionConfig | undefined;
+}
+export declare namespace StartInstanceOnboardingJobRequest {
+    
+    const filterSensitiveLog: (obj: StartInstanceOnboardingJobRequest) => any;
+}
+
+export interface StartInstanceOnboardingJobResponse {
+    
+    connectInstanceOnboardingJobStatus?: InstanceOnboardingJobStatus;
+}
+export declare namespace StartInstanceOnboardingJobResponse {
+    
+    const filterSensitiveLog: (obj: StartInstanceOnboardingJobResponse) => any;
+}
+
+export interface StopCampaignRequest {
+    
+    id: string | undefined;
+}
+export declare namespace StopCampaignRequest {
+    
+    const filterSensitiveLog: (obj: StopCampaignRequest) => any;
+}
+
+export interface TagResourceRequest {
+    
+    arn: string | undefined;
+    
+    tags: Record<string, string> | undefined;
+}
+export declare namespace TagResourceRequest {
+    
+    const filterSensitiveLog: (obj: TagResourceRequest) => any;
+}
+
+export interface UntagResourceRequest {
+    
+    arn: string | undefined;
+    
+    tagKeys: string[] | undefined;
+}
+export declare namespace UntagResourceRequest {
+    
+    const filterSensitiveLog: (obj: UntagResourceRequest) => any;
+}
+
+export interface UpdateCampaignDialerConfigRequest {
+    
+    id: string | undefined;
+    
+    dialerConfig: DialerConfig | undefined;
+}
+export declare namespace UpdateCampaignDialerConfigRequest {
+    
+    const filterSensitiveLog: (obj: UpdateCampaignDialerConfigRequest) => any;
+}
+
+export interface UpdateCampaignNameRequest {
+    
+    id: string | undefined;
+    
+    name: string | undefined;
+}
+export declare namespace UpdateCampaignNameRequest {
+    
+    const filterSensitiveLog: (obj: UpdateCampaignNameRequest) => any;
+}
+
+export interface UpdateCampaignOutboundCallConfigRequest {
+    
+    id: string | undefined;
+    
+    connectContactFlowId?: string;
+    
+    connectSourcePhoneNumber?: string;
+    
+    answerMachineDetectionConfig?: AnswerMachineDetectionConfig;
+}
+export declare namespace UpdateCampaignOutboundCallConfigRequest {
+    
+    const filterSensitiveLog: (obj: UpdateCampaignOutboundCallConfigRequest) => any;
+}

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

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@aws-sdk/types";
+import { ConnectCampaigns } from "../ConnectCampaigns";
+import { ConnectCampaignsClient } from "../ConnectCampaignsClient";
+export interface ConnectCampaignsPaginationConfiguration extends PaginationConfiguration {
+    client: ConnectCampaigns | ConnectCampaignsClient;
+}

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

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListCampaignsCommandInput, ListCampaignsCommandOutput } from "../commands/ListCampaignsCommand";
+import { ConnectCampaignsPaginationConfiguration } from "./Interfaces";
+export declare function paginateListCampaigns(config: ConnectCampaignsPaginationConfiguration, input: ListCampaignsCommandInput, ...additionalArguments: any): Paginator<ListCampaignsCommandOutput>;

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

@@ -0,0 +1,2 @@
+export * from "./Interfaces";
+export * from "./ListCampaignsPaginator";