mypydantic.models.connectcampaigns

  1# Model Generated: Thu Mar  2 21:56:17 2023
  2
  3from __future__ import annotations
  4
  5from datetime import datetime
  6from typing import Dict, List, Literal, Mapping, Optional, Sequence, Union
  7
  8from pydantic import Field
  9
 10from mypydantic.models.base_model import BaseModel
 11
 12
 13class AnswerMachineDetectionConfigModel(BaseModel):
 14    enable_answer_machine_detection: bool = Field(alias="enableAnswerMachineDetection")
 15
 16
 17class InstanceIdFilterModel(BaseModel):
 18    operator: Literal["Eq"] = Field(alias="operator")
 19    value: str = Field(alias="value")
 20
 21
 22class CampaignSummaryModel(BaseModel):
 23    arn: str = Field(alias="arn")
 24    connect_instance_id: str = Field(alias="connectInstanceId")
 25    id: str = Field(alias="id")
 26    name: str = Field(alias="name")
 27
 28
 29class ResponseMetadataModel(BaseModel):
 30    request_id: str = Field(alias="RequestId")
 31    host_id: str = Field(alias="HostId")
 32    http_status_code: int = Field(alias="HTTPStatusCode")
 33    http_headers: Dict[str, str] = Field(alias="HTTPHeaders")
 34    retry_attempts: int = Field(alias="RetryAttempts")
 35
 36
 37class DeleteCampaignRequestModel(BaseModel):
 38    id: str = Field(alias="id")
 39
 40
 41class DeleteConnectInstanceConfigRequestModel(BaseModel):
 42    connect_instance_id: str = Field(alias="connectInstanceId")
 43
 44
 45class DeleteInstanceOnboardingJobRequestModel(BaseModel):
 46    connect_instance_id: str = Field(alias="connectInstanceId")
 47
 48
 49class DescribeCampaignRequestModel(BaseModel):
 50    id: str = Field(alias="id")
 51
 52
 53class DialRequestModel(BaseModel):
 54    attributes: Mapping[str, str] = Field(alias="attributes")
 55    client_token: str = Field(alias="clientToken")
 56    expiration_time: Union[datetime, str] = Field(alias="expirationTime")
 57    phone_number: str = Field(alias="phoneNumber")
 58
 59
 60class PredictiveDialerConfigModel(BaseModel):
 61    bandwidth_allocation: float = Field(alias="bandwidthAllocation")
 62
 63
 64class ProgressiveDialerConfigModel(BaseModel):
 65    bandwidth_allocation: float = Field(alias="bandwidthAllocation")
 66
 67
 68class EncryptionConfigModel(BaseModel):
 69    enabled: bool = Field(alias="enabled")
 70    encryption_type: Optional[Literal["KMS"]] = Field(
 71        default=None, alias="encryptionType"
 72    )
 73    key_arn: Optional[str] = Field(default=None, alias="keyArn")
 74
 75
 76class FailedCampaignStateResponseModel(BaseModel):
 77    campaign_id: Optional[str] = Field(default=None, alias="campaignId")
 78    failure_code: Optional[Literal["ResourceNotFound", "UnknownError"]] = Field(
 79        default=None, alias="failureCode"
 80    )
 81
 82
 83class FailedRequestModel(BaseModel):
 84    client_token: Optional[str] = Field(default=None, alias="clientToken")
 85    failure_code: Optional[
 86        Literal["InvalidInput", "RequestThrottled", "UnknownError"]
 87    ] = Field(default=None, alias="failureCode")
 88    id: Optional[str] = Field(default=None, alias="id")
 89
 90
 91class GetCampaignStateBatchRequestModel(BaseModel):
 92    campaign_ids: Sequence[str] = Field(alias="campaignIds")
 93
 94
 95class SuccessfulCampaignStateResponseModel(BaseModel):
 96    campaign_id: Optional[str] = Field(default=None, alias="campaignId")
 97    state: Optional[
 98        Literal["Failed", "Initialized", "Paused", "Running", "Stopped"]
 99    ] = Field(default=None, alias="state")
100
101
102class GetCampaignStateRequestModel(BaseModel):
103    id: str = Field(alias="id")
104
105
106class GetConnectInstanceConfigRequestModel(BaseModel):
107    connect_instance_id: str = Field(alias="connectInstanceId")
108
109
110class GetInstanceOnboardingJobStatusRequestModel(BaseModel):
111    connect_instance_id: str = Field(alias="connectInstanceId")
112
113
114class InstanceOnboardingJobStatusModel(BaseModel):
115    connect_instance_id: str = Field(alias="connectInstanceId")
116    status: Literal["FAILED", "IN_PROGRESS", "SUCCEEDED"] = Field(alias="status")
117    failure_code: Optional[
118        Literal[
119            "EVENT_BRIDGE_ACCESS_DENIED",
120            "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED",
121            "IAM_ACCESS_DENIED",
122            "INTERNAL_FAILURE",
123            "KMS_ACCESS_DENIED",
124            "KMS_KEY_NOT_FOUND",
125        ]
126    ] = Field(default=None, alias="failureCode")
127
128
129class PaginatorConfigModel(BaseModel):
130    max_items: Optional[int] = Field(default=None, alias="MaxItems")
131    page_size: Optional[int] = Field(default=None, alias="PageSize")
132    starting_token: Optional[str] = Field(default=None, alias="StartingToken")
133
134
135class ListTagsForResourceRequestModel(BaseModel):
136    arn: str = Field(alias="arn")
137
138
139class PauseCampaignRequestModel(BaseModel):
140    id: str = Field(alias="id")
141
142
143class SuccessfulRequestModel(BaseModel):
144    client_token: Optional[str] = Field(default=None, alias="clientToken")
145    id: Optional[str] = Field(default=None, alias="id")
146
147
148class ResumeCampaignRequestModel(BaseModel):
149    id: str = Field(alias="id")
150
151
152class StartCampaignRequestModel(BaseModel):
153    id: str = Field(alias="id")
154
155
156class StopCampaignRequestModel(BaseModel):
157    id: str = Field(alias="id")
158
159
160class TagResourceRequestModel(BaseModel):
161    arn: str = Field(alias="arn")
162    tags: Mapping[str, str] = Field(alias="tags")
163
164
165class UntagResourceRequestModel(BaseModel):
166    arn: str = Field(alias="arn")
167    tag_keys: Sequence[str] = Field(alias="tagKeys")
168
169
170class UpdateCampaignNameRequestModel(BaseModel):
171    id: str = Field(alias="id")
172    name: str = Field(alias="name")
173
174
175class OutboundCallConfigModel(BaseModel):
176    connect_contact_flow_id: str = Field(alias="connectContactFlowId")
177    connect_queue_id: str = Field(alias="connectQueueId")
178    answer_machine_detection_config: Optional[
179        AnswerMachineDetectionConfigModel
180    ] = Field(default=None, alias="answerMachineDetectionConfig")
181    connect_source_phone_number: Optional[str] = Field(
182        default=None, alias="connectSourcePhoneNumber"
183    )
184
185
186class UpdateCampaignOutboundCallConfigRequestModel(BaseModel):
187    id: str = Field(alias="id")
188    answer_machine_detection_config: Optional[
189        AnswerMachineDetectionConfigModel
190    ] = Field(default=None, alias="answerMachineDetectionConfig")
191    connect_contact_flow_id: Optional[str] = Field(
192        default=None, alias="connectContactFlowId"
193    )
194    connect_source_phone_number: Optional[str] = Field(
195        default=None, alias="connectSourcePhoneNumber"
196    )
197
198
199class CampaignFiltersModel(BaseModel):
200    instance_id_filter: Optional[InstanceIdFilterModel] = Field(
201        default=None, alias="instanceIdFilter"
202    )
203
204
205class CreateCampaignResponseModel(BaseModel):
206    arn: str = Field(alias="arn")
207    id: str = Field(alias="id")
208    tags: Dict[str, str] = Field(alias="tags")
209    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
210
211
212class EmptyResponseMetadataModel(BaseModel):
213    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
214
215
216class GetCampaignStateResponseModel(BaseModel):
217    state: Literal["Failed", "Initialized", "Paused", "Running", "Stopped"] = Field(
218        alias="state"
219    )
220    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
221
222
223class ListCampaignsResponseModel(BaseModel):
224    campaign_summary_list: List[CampaignSummaryModel] = Field(
225        alias="campaignSummaryList"
226    )
227    next_token: str = Field(alias="nextToken")
228    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
229
230
231class ListTagsForResourceResponseModel(BaseModel):
232    tags: Dict[str, str] = Field(alias="tags")
233    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
234
235
236class PutDialRequestBatchRequestModel(BaseModel):
237    dial_requests: Sequence[DialRequestModel] = Field(alias="dialRequests")
238    id: str = Field(alias="id")
239
240
241class DialerConfigModel(BaseModel):
242    predictive_dialer_config: Optional[PredictiveDialerConfigModel] = Field(
243        default=None, alias="predictiveDialerConfig"
244    )
245    progressive_dialer_config: Optional[ProgressiveDialerConfigModel] = Field(
246        default=None, alias="progressiveDialerConfig"
247    )
248
249
250class InstanceConfigModel(BaseModel):
251    connect_instance_id: str = Field(alias="connectInstanceId")
252    encryption_config: EncryptionConfigModel = Field(alias="encryptionConfig")
253    service_linked_role_arn: str = Field(alias="serviceLinkedRoleArn")
254
255
256class StartInstanceOnboardingJobRequestModel(BaseModel):
257    connect_instance_id: str = Field(alias="connectInstanceId")
258    encryption_config: EncryptionConfigModel = Field(alias="encryptionConfig")
259
260
261class GetCampaignStateBatchResponseModel(BaseModel):
262    failed_requests: List[FailedCampaignStateResponseModel] = Field(
263        alias="failedRequests"
264    )
265    successful_requests: List[SuccessfulCampaignStateResponseModel] = Field(
266        alias="successfulRequests"
267    )
268    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
269
270
271class GetInstanceOnboardingJobStatusResponseModel(BaseModel):
272    connect_instance_onboarding_job_status: InstanceOnboardingJobStatusModel = Field(
273        alias="connectInstanceOnboardingJobStatus"
274    )
275    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
276
277
278class StartInstanceOnboardingJobResponseModel(BaseModel):
279    connect_instance_onboarding_job_status: InstanceOnboardingJobStatusModel = Field(
280        alias="connectInstanceOnboardingJobStatus"
281    )
282    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
283
284
285class PutDialRequestBatchResponseModel(BaseModel):
286    failed_requests: List[FailedRequestModel] = Field(alias="failedRequests")
287    successful_requests: List[SuccessfulRequestModel] = Field(
288        alias="successfulRequests"
289    )
290    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
291
292
293class ListCampaignsRequestListCampaignsPaginateModel(BaseModel):
294    filters: Optional[CampaignFiltersModel] = Field(default=None, alias="filters")
295    pagination_config: Optional[PaginatorConfigModel] = Field(
296        default=None, alias="PaginationConfig"
297    )
298
299
300class ListCampaignsRequestModel(BaseModel):
301    filters: Optional[CampaignFiltersModel] = Field(default=None, alias="filters")
302    max_results: Optional[int] = Field(default=None, alias="maxResults")
303    next_token: Optional[str] = Field(default=None, alias="nextToken")
304
305
306class CampaignModel(BaseModel):
307    arn: str = Field(alias="arn")
308    connect_instance_id: str = Field(alias="connectInstanceId")
309    dialer_config: DialerConfigModel = Field(alias="dialerConfig")
310    id: str = Field(alias="id")
311    name: str = Field(alias="name")
312    outbound_call_config: OutboundCallConfigModel = Field(alias="outboundCallConfig")
313    tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
314
315
316class CreateCampaignRequestModel(BaseModel):
317    connect_instance_id: str = Field(alias="connectInstanceId")
318    dialer_config: DialerConfigModel = Field(alias="dialerConfig")
319    name: str = Field(alias="name")
320    outbound_call_config: OutboundCallConfigModel = Field(alias="outboundCallConfig")
321    tags: Optional[Mapping[str, str]] = Field(default=None, alias="tags")
322
323
324class UpdateCampaignDialerConfigRequestModel(BaseModel):
325    dialer_config: DialerConfigModel = Field(alias="dialerConfig")
326    id: str = Field(alias="id")
327
328
329class GetConnectInstanceConfigResponseModel(BaseModel):
330    connect_instance_config: InstanceConfigModel = Field(alias="connectInstanceConfig")
331    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
332
333
334class DescribeCampaignResponseModel(BaseModel):
335    campaign: CampaignModel = Field(alias="campaign")
336    response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")