mypydantic.models.connectcases
1# Model Generated: Thu Mar 2 21:56:17 2023 2 3from __future__ import annotations 4 5from datetime import datetime 6from typing import Any, Dict, List, Literal, Mapping, Optional, Sequence 7 8from pydantic import Field 9 10from mypydantic.models.base_model import BaseModel 11 12 13class FieldIdentifierModel(BaseModel): 14 id: str = Field(alias="id") 15 16 17class FieldErrorModel(BaseModel): 18 error_code: str = Field(alias="errorCode") 19 id: str = Field(alias="id") 20 message: Optional[str] = Field(default=None, alias="message") 21 22 23class GetFieldResponseModel(BaseModel): 24 field_arn: str = Field(alias="fieldArn") 25 field_id: str = Field(alias="fieldId") 26 name: str = Field(alias="name") 27 namespace: Literal["Custom", "System"] = Field(alias="namespace") 28 type: Literal["Boolean", "DateTime", "Number", "SingleSelect", "Text"] = Field( 29 alias="type" 30 ) 31 description: Optional[str] = Field(default=None, alias="description") 32 tags: Optional[Dict[str, str]] = Field(default=None, alias="tags") 33 34 35class ResponseMetadataModel(BaseModel): 36 request_id: str = Field(alias="RequestId") 37 host_id: str = Field(alias="HostId") 38 http_status_code: int = Field(alias="HTTPStatusCode") 39 http_headers: Dict[str, str] = Field(alias="HTTPHeaders") 40 retry_attempts: int = Field(alias="RetryAttempts") 41 42 43class FieldOptionModel(BaseModel): 44 active: bool = Field(alias="active") 45 name: str = Field(alias="name") 46 value: str = Field(alias="value") 47 48 49class FieldOptionErrorModel(BaseModel): 50 error_code: str = Field(alias="errorCode") 51 message: str = Field(alias="message") 52 value: str = Field(alias="value") 53 54 55class CaseSummaryModel(BaseModel): 56 case_id: str = Field(alias="caseId") 57 template_id: str = Field(alias="templateId") 58 59 60class CommentContentModel(BaseModel): 61 body: str = Field(alias="body") 62 content_type: Literal["Text/Plain"] = Field(alias="contentType") 63 64 65class ContactContentModel(BaseModel): 66 channel: str = Field(alias="channel") 67 connected_to_system_time: datetime = Field(alias="connectedToSystemTime") 68 contact_arn: str = Field(alias="contactArn") 69 70 71class ContactFilterModel(BaseModel): 72 channel: Optional[Sequence[str]] = Field(default=None, alias="channel") 73 contact_arn: Optional[str] = Field(default=None, alias="contactArn") 74 75 76class ContactModel(BaseModel): 77 contact_arn: str = Field(alias="contactArn") 78 79 80class CreateDomainRequestModel(BaseModel): 81 name: str = Field(alias="name") 82 83 84class CreateFieldRequestModel(BaseModel): 85 domain_id: str = Field(alias="domainId") 86 name: str = Field(alias="name") 87 type: Literal["Boolean", "DateTime", "Number", "SingleSelect", "Text"] = Field( 88 alias="type" 89 ) 90 description: Optional[str] = Field(default=None, alias="description") 91 92 93class LayoutConfigurationModel(BaseModel): 94 default_layout: Optional[str] = Field(default=None, alias="defaultLayout") 95 96 97class RequiredFieldModel(BaseModel): 98 field_id: str = Field(alias="fieldId") 99 100 101class DeleteDomainRequestModel(BaseModel): 102 domain_id: str = Field(alias="domainId") 103 104 105class DomainSummaryModel(BaseModel): 106 domain_arn: str = Field(alias="domainArn") 107 domain_id: str = Field(alias="domainId") 108 name: str = Field(alias="name") 109 110 111class RelatedItemEventIncludedDataModel(BaseModel): 112 include_content: bool = Field(alias="includeContent") 113 114 115class FieldItemModel(BaseModel): 116 id: str = Field(alias="id") 117 118 119class FieldSummaryModel(BaseModel): 120 field_arn: str = Field(alias="fieldArn") 121 field_id: str = Field(alias="fieldId") 122 name: str = Field(alias="name") 123 namespace: Literal["Custom", "System"] = Field(alias="namespace") 124 type: Literal["Boolean", "DateTime", "Number", "SingleSelect", "Text"] = Field( 125 alias="type" 126 ) 127 128 129class FieldValueUnionModel(BaseModel): 130 boolean_value: Optional[bool] = Field(default=None, alias="booleanValue") 131 double_value: Optional[float] = Field(default=None, alias="doubleValue") 132 string_value: Optional[str] = Field(default=None, alias="stringValue") 133 134 135class GetCaseEventConfigurationRequestModel(BaseModel): 136 domain_id: str = Field(alias="domainId") 137 138 139class GetDomainRequestModel(BaseModel): 140 domain_id: str = Field(alias="domainId") 141 142 143class GetLayoutRequestModel(BaseModel): 144 domain_id: str = Field(alias="domainId") 145 layout_id: str = Field(alias="layoutId") 146 147 148class GetTemplateRequestModel(BaseModel): 149 domain_id: str = Field(alias="domainId") 150 template_id: str = Field(alias="templateId") 151 152 153class LayoutSummaryModel(BaseModel): 154 layout_arn: str = Field(alias="layoutArn") 155 layout_id: str = Field(alias="layoutId") 156 name: str = Field(alias="name") 157 158 159class ListCasesForContactRequestModel(BaseModel): 160 contact_arn: str = Field(alias="contactArn") 161 domain_id: str = Field(alias="domainId") 162 max_results: Optional[int] = Field(default=None, alias="maxResults") 163 next_token: Optional[str] = Field(default=None, alias="nextToken") 164 165 166class ListDomainsRequestModel(BaseModel): 167 max_results: Optional[int] = Field(default=None, alias="maxResults") 168 next_token: Optional[str] = Field(default=None, alias="nextToken") 169 170 171class ListFieldOptionsRequestModel(BaseModel): 172 domain_id: str = Field(alias="domainId") 173 field_id: str = Field(alias="fieldId") 174 max_results: Optional[int] = Field(default=None, alias="maxResults") 175 next_token: Optional[str] = Field(default=None, alias="nextToken") 176 values: Optional[Sequence[str]] = Field(default=None, alias="values") 177 178 179class ListFieldsRequestModel(BaseModel): 180 domain_id: str = Field(alias="domainId") 181 max_results: Optional[int] = Field(default=None, alias="maxResults") 182 next_token: Optional[str] = Field(default=None, alias="nextToken") 183 184 185class ListLayoutsRequestModel(BaseModel): 186 domain_id: str = Field(alias="domainId") 187 max_results: Optional[int] = Field(default=None, alias="maxResults") 188 next_token: Optional[str] = Field(default=None, alias="nextToken") 189 190 191class ListTagsForResourceRequestModel(BaseModel): 192 arn: str = Field(alias="arn") 193 194 195class ListTemplatesRequestModel(BaseModel): 196 domain_id: str = Field(alias="domainId") 197 max_results: Optional[int] = Field(default=None, alias="maxResults") 198 next_token: Optional[str] = Field(default=None, alias="nextToken") 199 status: Optional[Sequence[Literal["Active", "Inactive"]]] = Field( 200 default=None, alias="status" 201 ) 202 203 204class TemplateSummaryModel(BaseModel): 205 name: str = Field(alias="name") 206 status: Literal["Active", "Inactive"] = Field(alias="status") 207 template_arn: str = Field(alias="templateArn") 208 template_id: str = Field(alias="templateId") 209 210 211class PaginatorConfigModel(BaseModel): 212 max_items: Optional[int] = Field(default=None, alias="MaxItems") 213 page_size: Optional[int] = Field(default=None, alias="PageSize") 214 starting_token: Optional[str] = Field(default=None, alias="StartingToken") 215 216 217class SortModel(BaseModel): 218 field_id: str = Field(alias="fieldId") 219 sort_order: Literal["Asc", "Desc"] = Field(alias="sortOrder") 220 221 222class TagResourceRequestModel(BaseModel): 223 arn: str = Field(alias="arn") 224 tags: Mapping[str, str] = Field(alias="tags") 225 226 227class UntagResourceRequestModel(BaseModel): 228 arn: str = Field(alias="arn") 229 tag_keys: Sequence[str] = Field(alias="tagKeys") 230 231 232class UpdateFieldRequestModel(BaseModel): 233 domain_id: str = Field(alias="domainId") 234 field_id: str = Field(alias="fieldId") 235 description: Optional[str] = Field(default=None, alias="description") 236 name: Optional[str] = Field(default=None, alias="name") 237 238 239class BatchGetFieldRequestModel(BaseModel): 240 domain_id: str = Field(alias="domainId") 241 fields: Sequence[FieldIdentifierModel] = Field(alias="fields") 242 243 244class CaseEventIncludedDataModel(BaseModel): 245 fields: List[FieldIdentifierModel] = Field(alias="fields") 246 247 248class GetCaseRequestModel(BaseModel): 249 case_id: str = Field(alias="caseId") 250 domain_id: str = Field(alias="domainId") 251 fields: Sequence[FieldIdentifierModel] = Field(alias="fields") 252 next_token: Optional[str] = Field(default=None, alias="nextToken") 253 254 255class BatchGetFieldResponseModel(BaseModel): 256 errors: List[FieldErrorModel] = Field(alias="errors") 257 fields: List[GetFieldResponseModel] = Field(alias="fields") 258 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 259 260 261class CreateCaseResponseModel(BaseModel): 262 case_arn: str = Field(alias="caseArn") 263 case_id: str = Field(alias="caseId") 264 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 265 266 267class CreateDomainResponseModel(BaseModel): 268 domain_arn: str = Field(alias="domainArn") 269 domain_id: str = Field(alias="domainId") 270 domain_status: Literal["Active", "CreationFailed", "CreationInProgress"] = Field( 271 alias="domainStatus" 272 ) 273 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 274 275 276class CreateFieldResponseModel(BaseModel): 277 field_arn: str = Field(alias="fieldArn") 278 field_id: str = Field(alias="fieldId") 279 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 280 281 282class CreateLayoutResponseModel(BaseModel): 283 layout_arn: str = Field(alias="layoutArn") 284 layout_id: str = Field(alias="layoutId") 285 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 286 287 288class CreateRelatedItemResponseModel(BaseModel): 289 related_item_arn: str = Field(alias="relatedItemArn") 290 related_item_id: str = Field(alias="relatedItemId") 291 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 292 293 294class CreateTemplateResponseModel(BaseModel): 295 template_arn: str = Field(alias="templateArn") 296 template_id: str = Field(alias="templateId") 297 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 298 299 300class EmptyResponseMetadataModel(BaseModel): 301 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 302 303 304class GetDomainResponseModel(BaseModel): 305 created_time: datetime = Field(alias="createdTime") 306 domain_arn: str = Field(alias="domainArn") 307 domain_id: str = Field(alias="domainId") 308 domain_status: Literal["Active", "CreationFailed", "CreationInProgress"] = Field( 309 alias="domainStatus" 310 ) 311 name: str = Field(alias="name") 312 tags: Dict[str, str] = Field(alias="tags") 313 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 314 315 316class ListTagsForResourceResponseModel(BaseModel): 317 tags: Dict[str, str] = Field(alias="tags") 318 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 319 320 321class BatchPutFieldOptionsRequestModel(BaseModel): 322 domain_id: str = Field(alias="domainId") 323 field_id: str = Field(alias="fieldId") 324 options: Sequence[FieldOptionModel] = Field(alias="options") 325 326 327class ListFieldOptionsResponseModel(BaseModel): 328 next_token: str = Field(alias="nextToken") 329 options: List[FieldOptionModel] = Field(alias="options") 330 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 331 332 333class BatchPutFieldOptionsResponseModel(BaseModel): 334 errors: List[FieldOptionErrorModel] = Field(alias="errors") 335 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 336 337 338class ListCasesForContactResponseModel(BaseModel): 339 cases: List[CaseSummaryModel] = Field(alias="cases") 340 next_token: str = Field(alias="nextToken") 341 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 342 343 344class RelatedItemContentModel(BaseModel): 345 comment: Optional[CommentContentModel] = Field(default=None, alias="comment") 346 contact: Optional[ContactContentModel] = Field(default=None, alias="contact") 347 348 349class RelatedItemTypeFilterModel(BaseModel): 350 comment: Optional[Mapping[str, Any]] = Field(default=None, alias="comment") 351 contact: Optional[ContactFilterModel] = Field(default=None, alias="contact") 352 353 354class RelatedItemInputContentModel(BaseModel): 355 comment: Optional[CommentContentModel] = Field(default=None, alias="comment") 356 contact: Optional[ContactModel] = Field(default=None, alias="contact") 357 358 359class CreateTemplateRequestModel(BaseModel): 360 domain_id: str = Field(alias="domainId") 361 name: str = Field(alias="name") 362 description: Optional[str] = Field(default=None, alias="description") 363 layout_configuration: Optional[LayoutConfigurationModel] = Field( 364 default=None, alias="layoutConfiguration" 365 ) 366 required_fields: Optional[Sequence[RequiredFieldModel]] = Field( 367 default=None, alias="requiredFields" 368 ) 369 status: Optional[Literal["Active", "Inactive"]] = Field( 370 default=None, alias="status" 371 ) 372 373 374class GetTemplateResponseModel(BaseModel): 375 description: str = Field(alias="description") 376 layout_configuration: LayoutConfigurationModel = Field(alias="layoutConfiguration") 377 name: str = Field(alias="name") 378 required_fields: List[RequiredFieldModel] = Field(alias="requiredFields") 379 status: Literal["Active", "Inactive"] = Field(alias="status") 380 tags: Dict[str, str] = Field(alias="tags") 381 template_arn: str = Field(alias="templateArn") 382 template_id: str = Field(alias="templateId") 383 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 384 385 386class UpdateTemplateRequestModel(BaseModel): 387 domain_id: str = Field(alias="domainId") 388 template_id: str = Field(alias="templateId") 389 description: Optional[str] = Field(default=None, alias="description") 390 layout_configuration: Optional[LayoutConfigurationModel] = Field( 391 default=None, alias="layoutConfiguration" 392 ) 393 name: Optional[str] = Field(default=None, alias="name") 394 required_fields: Optional[Sequence[RequiredFieldModel]] = Field( 395 default=None, alias="requiredFields" 396 ) 397 status: Optional[Literal["Active", "Inactive"]] = Field( 398 default=None, alias="status" 399 ) 400 401 402class ListDomainsResponseModel(BaseModel): 403 domains: List[DomainSummaryModel] = Field(alias="domains") 404 next_token: str = Field(alias="nextToken") 405 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 406 407 408class FieldGroupModel(BaseModel): 409 fields: Sequence[FieldItemModel] = Field(alias="fields") 410 name: Optional[str] = Field(default=None, alias="name") 411 412 413class ListFieldsResponseModel(BaseModel): 414 fields: List[FieldSummaryModel] = Field(alias="fields") 415 next_token: str = Field(alias="nextToken") 416 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 417 418 419class FieldValueModel(BaseModel): 420 id: str = Field(alias="id") 421 value: FieldValueUnionModel = Field(alias="value") 422 423 424class ListLayoutsResponseModel(BaseModel): 425 layouts: List[LayoutSummaryModel] = Field(alias="layouts") 426 next_token: str = Field(alias="nextToken") 427 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 428 429 430class ListTemplatesResponseModel(BaseModel): 431 next_token: str = Field(alias="nextToken") 432 templates: List[TemplateSummaryModel] = Field(alias="templates") 433 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 434 435 436class SearchCasesRequestModel(BaseModel): 437 domain_id: str = Field(alias="domainId") 438 fields: Optional[Sequence[FieldIdentifierModel]] = Field( 439 default=None, alias="fields" 440 ) 441 filter: Optional[CaseFilterModel] = Field(default=None, alias="filter") 442 max_results: Optional[int] = Field(default=None, alias="maxResults") 443 next_token: Optional[str] = Field(default=None, alias="nextToken") 444 search_term: Optional[str] = Field(default=None, alias="searchTerm") 445 sorts: Optional[Sequence[SortModel]] = Field(default=None, alias="sorts") 446 447 448class SearchCasesRequestSearchCasesPaginateModel(BaseModel): 449 domain_id: str = Field(alias="domainId") 450 fields: Optional[Sequence[FieldIdentifierModel]] = Field( 451 default=None, alias="fields" 452 ) 453 filter: Optional[CaseFilterModel] = Field(default=None, alias="filter") 454 search_term: Optional[str] = Field(default=None, alias="searchTerm") 455 sorts: Optional[Sequence[SortModel]] = Field(default=None, alias="sorts") 456 pagination_config: Optional[PaginatorConfigModel] = Field( 457 default=None, alias="PaginationConfig" 458 ) 459 460 461class EventIncludedDataModel(BaseModel): 462 case_data: Optional[CaseEventIncludedDataModel] = Field( 463 default=None, alias="caseData" 464 ) 465 related_item_data: Optional[RelatedItemEventIncludedDataModel] = Field( 466 default=None, alias="relatedItemData" 467 ) 468 469 470class SearchRelatedItemsResponseItemModel(BaseModel): 471 association_time: datetime = Field(alias="associationTime") 472 content: RelatedItemContentModel = Field(alias="content") 473 related_item_id: str = Field(alias="relatedItemId") 474 type: Literal["Comment", "Contact"] = Field(alias="type") 475 tags: Optional[Dict[str, str]] = Field(default=None, alias="tags") 476 477 478class SearchRelatedItemsRequestModel(BaseModel): 479 case_id: str = Field(alias="caseId") 480 domain_id: str = Field(alias="domainId") 481 filters: Optional[Sequence[RelatedItemTypeFilterModel]] = Field( 482 default=None, alias="filters" 483 ) 484 max_results: Optional[int] = Field(default=None, alias="maxResults") 485 next_token: Optional[str] = Field(default=None, alias="nextToken") 486 487 488class SearchRelatedItemsRequestSearchRelatedItemsPaginateModel(BaseModel): 489 case_id: str = Field(alias="caseId") 490 domain_id: str = Field(alias="domainId") 491 filters: Optional[Sequence[RelatedItemTypeFilterModel]] = Field( 492 default=None, alias="filters" 493 ) 494 pagination_config: Optional[PaginatorConfigModel] = Field( 495 default=None, alias="PaginationConfig" 496 ) 497 498 499class CreateRelatedItemRequestModel(BaseModel): 500 case_id: str = Field(alias="caseId") 501 content: RelatedItemInputContentModel = Field(alias="content") 502 domain_id: str = Field(alias="domainId") 503 type: Literal["Comment", "Contact"] = Field(alias="type") 504 505 506class SectionModel(BaseModel): 507 field_group: Optional[FieldGroupModel] = Field(default=None, alias="fieldGroup") 508 509 510class CreateCaseRequestModel(BaseModel): 511 domain_id: str = Field(alias="domainId") 512 fields: Sequence[FieldValueModel] = Field(alias="fields") 513 template_id: str = Field(alias="templateId") 514 client_token: Optional[str] = Field(default=None, alias="clientToken") 515 516 517class FieldFilterModel(BaseModel): 518 contains: Optional[FieldValueModel] = Field(default=None, alias="contains") 519 equal_to: Optional[FieldValueModel] = Field(default=None, alias="equalTo") 520 greater_than: Optional[FieldValueModel] = Field(default=None, alias="greaterThan") 521 greater_than_or_equal_to: Optional[FieldValueModel] = Field( 522 default=None, alias="greaterThanOrEqualTo" 523 ) 524 less_than: Optional[FieldValueModel] = Field(default=None, alias="lessThan") 525 less_than_or_equal_to: Optional[FieldValueModel] = Field( 526 default=None, alias="lessThanOrEqualTo" 527 ) 528 529 530class GetCaseResponseModel(BaseModel): 531 fields: List[FieldValueModel] = Field(alias="fields") 532 next_token: str = Field(alias="nextToken") 533 tags: Dict[str, str] = Field(alias="tags") 534 template_id: str = Field(alias="templateId") 535 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 536 537 538class SearchCasesResponseItemModel(BaseModel): 539 case_id: str = Field(alias="caseId") 540 fields: List[FieldValueModel] = Field(alias="fields") 541 template_id: str = Field(alias="templateId") 542 tags: Optional[Dict[str, str]] = Field(default=None, alias="tags") 543 544 545class UpdateCaseRequestModel(BaseModel): 546 case_id: str = Field(alias="caseId") 547 domain_id: str = Field(alias="domainId") 548 fields: Sequence[FieldValueModel] = Field(alias="fields") 549 550 551class EventBridgeConfigurationModel(BaseModel): 552 enabled: bool = Field(alias="enabled") 553 included_data: Optional[EventIncludedDataModel] = Field( 554 default=None, alias="includedData" 555 ) 556 557 558class SearchRelatedItemsResponseModel(BaseModel): 559 next_token: str = Field(alias="nextToken") 560 related_items: List[SearchRelatedItemsResponseItemModel] = Field( 561 alias="relatedItems" 562 ) 563 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 564 565 566class LayoutSectionsModel(BaseModel): 567 sections: Optional[Sequence[SectionModel]] = Field(default=None, alias="sections") 568 569 570class CaseFilterModel(BaseModel): 571 and_all: Optional[Sequence[Dict[str, Any]]] = Field(default=None, alias="andAll") 572 field: Optional[FieldFilterModel] = Field(default=None, alias="field") 573 not_: Optional[Dict[str, Any]] = Field(default=None, alias="not") 574 575 576class SearchCasesResponseModel(BaseModel): 577 cases: List[SearchCasesResponseItemModel] = Field(alias="cases") 578 next_token: str = Field(alias="nextToken") 579 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 580 581 582class GetCaseEventConfigurationResponseModel(BaseModel): 583 event_bridge: EventBridgeConfigurationModel = Field(alias="eventBridge") 584 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 585 586 587class PutCaseEventConfigurationRequestModel(BaseModel): 588 domain_id: str = Field(alias="domainId") 589 event_bridge: EventBridgeConfigurationModel = Field(alias="eventBridge") 590 591 592class BasicLayoutModel(BaseModel): 593 more_info: Optional[LayoutSectionsModel] = Field(default=None, alias="moreInfo") 594 top_panel: Optional[LayoutSectionsModel] = Field(default=None, alias="topPanel") 595 596 597class LayoutContentModel(BaseModel): 598 basic: Optional[BasicLayoutModel] = Field(default=None, alias="basic") 599 600 601class CreateLayoutRequestModel(BaseModel): 602 content: LayoutContentModel = Field(alias="content") 603 domain_id: str = Field(alias="domainId") 604 name: str = Field(alias="name") 605 606 607class GetLayoutResponseModel(BaseModel): 608 content: LayoutContentModel = Field(alias="content") 609 layout_arn: str = Field(alias="layoutArn") 610 layout_id: str = Field(alias="layoutId") 611 name: str = Field(alias="name") 612 tags: Dict[str, str] = Field(alias="tags") 613 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 614 615 616class UpdateLayoutRequestModel(BaseModel): 617 domain_id: str = Field(alias="domainId") 618 layout_id: str = Field(alias="layoutId") 619 content: Optional[LayoutContentModel] = Field(default=None, alias="content") 620 name: Optional[str] = Field(default=None, alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
18class FieldErrorModel(BaseModel): 19 error_code: str = Field(alias="errorCode") 20 id: str = Field(alias="id") 21 message: Optional[str] = Field(default=None, alias="message")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
24class GetFieldResponseModel(BaseModel): 25 field_arn: str = Field(alias="fieldArn") 26 field_id: str = Field(alias="fieldId") 27 name: str = Field(alias="name") 28 namespace: Literal["Custom", "System"] = Field(alias="namespace") 29 type: Literal["Boolean", "DateTime", "Number", "SingleSelect", "Text"] = Field( 30 alias="type" 31 ) 32 description: Optional[str] = Field(default=None, alias="description") 33 tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
36class ResponseMetadataModel(BaseModel): 37 request_id: str = Field(alias="RequestId") 38 host_id: str = Field(alias="HostId") 39 http_status_code: int = Field(alias="HTTPStatusCode") 40 http_headers: Dict[str, str] = Field(alias="HTTPHeaders") 41 retry_attempts: int = Field(alias="RetryAttempts")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
44class FieldOptionModel(BaseModel): 45 active: bool = Field(alias="active") 46 name: str = Field(alias="name") 47 value: str = Field(alias="value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
50class FieldOptionErrorModel(BaseModel): 51 error_code: str = Field(alias="errorCode") 52 message: str = Field(alias="message") 53 value: str = Field(alias="value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
56class CaseSummaryModel(BaseModel): 57 case_id: str = Field(alias="caseId") 58 template_id: str = Field(alias="templateId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
61class CommentContentModel(BaseModel): 62 body: str = Field(alias="body") 63 content_type: Literal["Text/Plain"] = Field(alias="contentType")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
66class ContactContentModel(BaseModel): 67 channel: str = Field(alias="channel") 68 connected_to_system_time: datetime = Field(alias="connectedToSystemTime") 69 contact_arn: str = Field(alias="contactArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
72class ContactFilterModel(BaseModel): 73 channel: Optional[Sequence[str]] = Field(default=None, alias="channel") 74 contact_arn: Optional[str] = Field(default=None, alias="contactArn")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
85class CreateFieldRequestModel(BaseModel): 86 domain_id: str = Field(alias="domainId") 87 name: str = Field(alias="name") 88 type: Literal["Boolean", "DateTime", "Number", "SingleSelect", "Text"] = Field( 89 alias="type" 90 ) 91 description: Optional[str] = Field(default=None, alias="description")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
94class LayoutConfigurationModel(BaseModel): 95 default_layout: Optional[str] = Field(default=None, alias="defaultLayout")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
106class DomainSummaryModel(BaseModel): 107 domain_arn: str = Field(alias="domainArn") 108 domain_id: str = Field(alias="domainId") 109 name: str = Field(alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
112class RelatedItemEventIncludedDataModel(BaseModel): 113 include_content: bool = Field(alias="includeContent")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
120class FieldSummaryModel(BaseModel): 121 field_arn: str = Field(alias="fieldArn") 122 field_id: str = Field(alias="fieldId") 123 name: str = Field(alias="name") 124 namespace: Literal["Custom", "System"] = Field(alias="namespace") 125 type: Literal["Boolean", "DateTime", "Number", "SingleSelect", "Text"] = Field( 126 alias="type" 127 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
130class FieldValueUnionModel(BaseModel): 131 boolean_value: Optional[bool] = Field(default=None, alias="booleanValue") 132 double_value: Optional[float] = Field(default=None, alias="doubleValue") 133 string_value: Optional[str] = Field(default=None, alias="stringValue")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
136class GetCaseEventConfigurationRequestModel(BaseModel): 137 domain_id: str = Field(alias="domainId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
144class GetLayoutRequestModel(BaseModel): 145 domain_id: str = Field(alias="domainId") 146 layout_id: str = Field(alias="layoutId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
149class GetTemplateRequestModel(BaseModel): 150 domain_id: str = Field(alias="domainId") 151 template_id: str = Field(alias="templateId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
154class LayoutSummaryModel(BaseModel): 155 layout_arn: str = Field(alias="layoutArn") 156 layout_id: str = Field(alias="layoutId") 157 name: str = Field(alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
160class ListCasesForContactRequestModel(BaseModel): 161 contact_arn: str = Field(alias="contactArn") 162 domain_id: str = Field(alias="domainId") 163 max_results: Optional[int] = Field(default=None, alias="maxResults") 164 next_token: Optional[str] = Field(default=None, alias="nextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
167class ListDomainsRequestModel(BaseModel): 168 max_results: Optional[int] = Field(default=None, alias="maxResults") 169 next_token: Optional[str] = Field(default=None, alias="nextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
172class ListFieldOptionsRequestModel(BaseModel): 173 domain_id: str = Field(alias="domainId") 174 field_id: str = Field(alias="fieldId") 175 max_results: Optional[int] = Field(default=None, alias="maxResults") 176 next_token: Optional[str] = Field(default=None, alias="nextToken") 177 values: Optional[Sequence[str]] = Field(default=None, alias="values")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
180class ListFieldsRequestModel(BaseModel): 181 domain_id: str = Field(alias="domainId") 182 max_results: Optional[int] = Field(default=None, alias="maxResults") 183 next_token: Optional[str] = Field(default=None, alias="nextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
186class ListLayoutsRequestModel(BaseModel): 187 domain_id: str = Field(alias="domainId") 188 max_results: Optional[int] = Field(default=None, alias="maxResults") 189 next_token: Optional[str] = Field(default=None, alias="nextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
196class ListTemplatesRequestModel(BaseModel): 197 domain_id: str = Field(alias="domainId") 198 max_results: Optional[int] = Field(default=None, alias="maxResults") 199 next_token: Optional[str] = Field(default=None, alias="nextToken") 200 status: Optional[Sequence[Literal["Active", "Inactive"]]] = Field( 201 default=None, alias="status" 202 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
205class TemplateSummaryModel(BaseModel): 206 name: str = Field(alias="name") 207 status: Literal["Active", "Inactive"] = Field(alias="status") 208 template_arn: str = Field(alias="templateArn") 209 template_id: str = Field(alias="templateId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
212class PaginatorConfigModel(BaseModel): 213 max_items: Optional[int] = Field(default=None, alias="MaxItems") 214 page_size: Optional[int] = Field(default=None, alias="PageSize") 215 starting_token: Optional[str] = Field(default=None, alias="StartingToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
218class SortModel(BaseModel): 219 field_id: str = Field(alias="fieldId") 220 sort_order: Literal["Asc", "Desc"] = Field(alias="sortOrder")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
223class TagResourceRequestModel(BaseModel): 224 arn: str = Field(alias="arn") 225 tags: Mapping[str, str] = Field(alias="tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
228class UntagResourceRequestModel(BaseModel): 229 arn: str = Field(alias="arn") 230 tag_keys: Sequence[str] = Field(alias="tagKeys")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
233class UpdateFieldRequestModel(BaseModel): 234 domain_id: str = Field(alias="domainId") 235 field_id: str = Field(alias="fieldId") 236 description: Optional[str] = Field(default=None, alias="description") 237 name: Optional[str] = Field(default=None, alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
240class BatchGetFieldRequestModel(BaseModel): 241 domain_id: str = Field(alias="domainId") 242 fields: Sequence[FieldIdentifierModel] = Field(alias="fields")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
245class CaseEventIncludedDataModel(BaseModel): 246 fields: List[FieldIdentifierModel] = Field(alias="fields")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
249class GetCaseRequestModel(BaseModel): 250 case_id: str = Field(alias="caseId") 251 domain_id: str = Field(alias="domainId") 252 fields: Sequence[FieldIdentifierModel] = Field(alias="fields") 253 next_token: Optional[str] = Field(default=None, alias="nextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
256class BatchGetFieldResponseModel(BaseModel): 257 errors: List[FieldErrorModel] = Field(alias="errors") 258 fields: List[GetFieldResponseModel] = Field(alias="fields") 259 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
262class CreateCaseResponseModel(BaseModel): 263 case_arn: str = Field(alias="caseArn") 264 case_id: str = Field(alias="caseId") 265 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
268class CreateDomainResponseModel(BaseModel): 269 domain_arn: str = Field(alias="domainArn") 270 domain_id: str = Field(alias="domainId") 271 domain_status: Literal["Active", "CreationFailed", "CreationInProgress"] = Field( 272 alias="domainStatus" 273 ) 274 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
277class CreateFieldResponseModel(BaseModel): 278 field_arn: str = Field(alias="fieldArn") 279 field_id: str = Field(alias="fieldId") 280 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
283class CreateLayoutResponseModel(BaseModel): 284 layout_arn: str = Field(alias="layoutArn") 285 layout_id: str = Field(alias="layoutId") 286 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
289class CreateRelatedItemResponseModel(BaseModel): 290 related_item_arn: str = Field(alias="relatedItemArn") 291 related_item_id: str = Field(alias="relatedItemId") 292 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
295class CreateTemplateResponseModel(BaseModel): 296 template_arn: str = Field(alias="templateArn") 297 template_id: str = Field(alias="templateId") 298 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
301class EmptyResponseMetadataModel(BaseModel): 302 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
305class GetDomainResponseModel(BaseModel): 306 created_time: datetime = Field(alias="createdTime") 307 domain_arn: str = Field(alias="domainArn") 308 domain_id: str = Field(alias="domainId") 309 domain_status: Literal["Active", "CreationFailed", "CreationInProgress"] = Field( 310 alias="domainStatus" 311 ) 312 name: str = Field(alias="name") 313 tags: Dict[str, str] = Field(alias="tags") 314 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
317class ListTagsForResourceResponseModel(BaseModel): 318 tags: Dict[str, str] = Field(alias="tags") 319 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
322class BatchPutFieldOptionsRequestModel(BaseModel): 323 domain_id: str = Field(alias="domainId") 324 field_id: str = Field(alias="fieldId") 325 options: Sequence[FieldOptionModel] = Field(alias="options")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
328class ListFieldOptionsResponseModel(BaseModel): 329 next_token: str = Field(alias="nextToken") 330 options: List[FieldOptionModel] = Field(alias="options") 331 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
334class BatchPutFieldOptionsResponseModel(BaseModel): 335 errors: List[FieldOptionErrorModel] = Field(alias="errors") 336 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
339class ListCasesForContactResponseModel(BaseModel): 340 cases: List[CaseSummaryModel] = Field(alias="cases") 341 next_token: str = Field(alias="nextToken") 342 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
345class RelatedItemContentModel(BaseModel): 346 comment: Optional[CommentContentModel] = Field(default=None, alias="comment") 347 contact: Optional[ContactContentModel] = Field(default=None, alias="contact")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
350class RelatedItemTypeFilterModel(BaseModel): 351 comment: Optional[Mapping[str, Any]] = Field(default=None, alias="comment") 352 contact: Optional[ContactFilterModel] = Field(default=None, alias="contact")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
355class RelatedItemInputContentModel(BaseModel): 356 comment: Optional[CommentContentModel] = Field(default=None, alias="comment") 357 contact: Optional[ContactModel] = Field(default=None, alias="contact")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
360class CreateTemplateRequestModel(BaseModel): 361 domain_id: str = Field(alias="domainId") 362 name: str = Field(alias="name") 363 description: Optional[str] = Field(default=None, alias="description") 364 layout_configuration: Optional[LayoutConfigurationModel] = Field( 365 default=None, alias="layoutConfiguration" 366 ) 367 required_fields: Optional[Sequence[RequiredFieldModel]] = Field( 368 default=None, alias="requiredFields" 369 ) 370 status: Optional[Literal["Active", "Inactive"]] = Field( 371 default=None, alias="status" 372 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
375class GetTemplateResponseModel(BaseModel): 376 description: str = Field(alias="description") 377 layout_configuration: LayoutConfigurationModel = Field(alias="layoutConfiguration") 378 name: str = Field(alias="name") 379 required_fields: List[RequiredFieldModel] = Field(alias="requiredFields") 380 status: Literal["Active", "Inactive"] = Field(alias="status") 381 tags: Dict[str, str] = Field(alias="tags") 382 template_arn: str = Field(alias="templateArn") 383 template_id: str = Field(alias="templateId") 384 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
387class UpdateTemplateRequestModel(BaseModel): 388 domain_id: str = Field(alias="domainId") 389 template_id: str = Field(alias="templateId") 390 description: Optional[str] = Field(default=None, alias="description") 391 layout_configuration: Optional[LayoutConfigurationModel] = Field( 392 default=None, alias="layoutConfiguration" 393 ) 394 name: Optional[str] = Field(default=None, alias="name") 395 required_fields: Optional[Sequence[RequiredFieldModel]] = Field( 396 default=None, alias="requiredFields" 397 ) 398 status: Optional[Literal["Active", "Inactive"]] = Field( 399 default=None, alias="status" 400 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
403class ListDomainsResponseModel(BaseModel): 404 domains: List[DomainSummaryModel] = Field(alias="domains") 405 next_token: str = Field(alias="nextToken") 406 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
409class FieldGroupModel(BaseModel): 410 fields: Sequence[FieldItemModel] = Field(alias="fields") 411 name: Optional[str] = Field(default=None, alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
414class ListFieldsResponseModel(BaseModel): 415 fields: List[FieldSummaryModel] = Field(alias="fields") 416 next_token: str = Field(alias="nextToken") 417 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
420class FieldValueModel(BaseModel): 421 id: str = Field(alias="id") 422 value: FieldValueUnionModel = Field(alias="value")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
425class ListLayoutsResponseModel(BaseModel): 426 layouts: List[LayoutSummaryModel] = Field(alias="layouts") 427 next_token: str = Field(alias="nextToken") 428 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
431class ListTemplatesResponseModel(BaseModel): 432 next_token: str = Field(alias="nextToken") 433 templates: List[TemplateSummaryModel] = Field(alias="templates") 434 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
437class SearchCasesRequestModel(BaseModel): 438 domain_id: str = Field(alias="domainId") 439 fields: Optional[Sequence[FieldIdentifierModel]] = Field( 440 default=None, alias="fields" 441 ) 442 filter: Optional[CaseFilterModel] = Field(default=None, alias="filter") 443 max_results: Optional[int] = Field(default=None, alias="maxResults") 444 next_token: Optional[str] = Field(default=None, alias="nextToken") 445 search_term: Optional[str] = Field(default=None, alias="searchTerm") 446 sorts: Optional[Sequence[SortModel]] = Field(default=None, alias="sorts")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
449class SearchCasesRequestSearchCasesPaginateModel(BaseModel): 450 domain_id: str = Field(alias="domainId") 451 fields: Optional[Sequence[FieldIdentifierModel]] = Field( 452 default=None, alias="fields" 453 ) 454 filter: Optional[CaseFilterModel] = Field(default=None, alias="filter") 455 search_term: Optional[str] = Field(default=None, alias="searchTerm") 456 sorts: Optional[Sequence[SortModel]] = Field(default=None, alias="sorts") 457 pagination_config: Optional[PaginatorConfigModel] = Field( 458 default=None, alias="PaginationConfig" 459 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
462class EventIncludedDataModel(BaseModel): 463 case_data: Optional[CaseEventIncludedDataModel] = Field( 464 default=None, alias="caseData" 465 ) 466 related_item_data: Optional[RelatedItemEventIncludedDataModel] = Field( 467 default=None, alias="relatedItemData" 468 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
471class SearchRelatedItemsResponseItemModel(BaseModel): 472 association_time: datetime = Field(alias="associationTime") 473 content: RelatedItemContentModel = Field(alias="content") 474 related_item_id: str = Field(alias="relatedItemId") 475 type: Literal["Comment", "Contact"] = Field(alias="type") 476 tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
479class SearchRelatedItemsRequestModel(BaseModel): 480 case_id: str = Field(alias="caseId") 481 domain_id: str = Field(alias="domainId") 482 filters: Optional[Sequence[RelatedItemTypeFilterModel]] = Field( 483 default=None, alias="filters" 484 ) 485 max_results: Optional[int] = Field(default=None, alias="maxResults") 486 next_token: Optional[str] = Field(default=None, alias="nextToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
class
SearchRelatedItemsRequestSearchRelatedItemsPaginateModel(mypydantic.models.base_model.BaseModel):
489class SearchRelatedItemsRequestSearchRelatedItemsPaginateModel(BaseModel): 490 case_id: str = Field(alias="caseId") 491 domain_id: str = Field(alias="domainId") 492 filters: Optional[Sequence[RelatedItemTypeFilterModel]] = Field( 493 default=None, alias="filters" 494 ) 495 pagination_config: Optional[PaginatorConfigModel] = Field( 496 default=None, alias="PaginationConfig" 497 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
500class CreateRelatedItemRequestModel(BaseModel): 501 case_id: str = Field(alias="caseId") 502 content: RelatedItemInputContentModel = Field(alias="content") 503 domain_id: str = Field(alias="domainId") 504 type: Literal["Comment", "Contact"] = Field(alias="type")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
507class SectionModel(BaseModel): 508 field_group: Optional[FieldGroupModel] = Field(default=None, alias="fieldGroup")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
511class CreateCaseRequestModel(BaseModel): 512 domain_id: str = Field(alias="domainId") 513 fields: Sequence[FieldValueModel] = Field(alias="fields") 514 template_id: str = Field(alias="templateId") 515 client_token: Optional[str] = Field(default=None, alias="clientToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
518class FieldFilterModel(BaseModel): 519 contains: Optional[FieldValueModel] = Field(default=None, alias="contains") 520 equal_to: Optional[FieldValueModel] = Field(default=None, alias="equalTo") 521 greater_than: Optional[FieldValueModel] = Field(default=None, alias="greaterThan") 522 greater_than_or_equal_to: Optional[FieldValueModel] = Field( 523 default=None, alias="greaterThanOrEqualTo" 524 ) 525 less_than: Optional[FieldValueModel] = Field(default=None, alias="lessThan") 526 less_than_or_equal_to: Optional[FieldValueModel] = Field( 527 default=None, alias="lessThanOrEqualTo" 528 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
531class GetCaseResponseModel(BaseModel): 532 fields: List[FieldValueModel] = Field(alias="fields") 533 next_token: str = Field(alias="nextToken") 534 tags: Dict[str, str] = Field(alias="tags") 535 template_id: str = Field(alias="templateId") 536 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
539class SearchCasesResponseItemModel(BaseModel): 540 case_id: str = Field(alias="caseId") 541 fields: List[FieldValueModel] = Field(alias="fields") 542 template_id: str = Field(alias="templateId") 543 tags: Optional[Dict[str, str]] = Field(default=None, alias="tags")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
546class UpdateCaseRequestModel(BaseModel): 547 case_id: str = Field(alias="caseId") 548 domain_id: str = Field(alias="domainId") 549 fields: Sequence[FieldValueModel] = Field(alias="fields")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
552class EventBridgeConfigurationModel(BaseModel): 553 enabled: bool = Field(alias="enabled") 554 included_data: Optional[EventIncludedDataModel] = Field( 555 default=None, alias="includedData" 556 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
559class SearchRelatedItemsResponseModel(BaseModel): 560 next_token: str = Field(alias="nextToken") 561 related_items: List[SearchRelatedItemsResponseItemModel] = Field( 562 alias="relatedItems" 563 ) 564 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
567class LayoutSectionsModel(BaseModel): 568 sections: Optional[Sequence[SectionModel]] = Field(default=None, alias="sections")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
571class CaseFilterModel(BaseModel): 572 and_all: Optional[Sequence[Dict[str, Any]]] = Field(default=None, alias="andAll") 573 field: Optional[FieldFilterModel] = Field(default=None, alias="field") 574 not_: Optional[Dict[str, Any]] = Field(default=None, alias="not")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
577class SearchCasesResponseModel(BaseModel): 578 cases: List[SearchCasesResponseItemModel] = Field(alias="cases") 579 next_token: str = Field(alias="nextToken") 580 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
583class GetCaseEventConfigurationResponseModel(BaseModel): 584 event_bridge: EventBridgeConfigurationModel = Field(alias="eventBridge") 585 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
588class PutCaseEventConfigurationRequestModel(BaseModel): 589 domain_id: str = Field(alias="domainId") 590 event_bridge: EventBridgeConfigurationModel = Field(alias="eventBridge")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
593class BasicLayoutModel(BaseModel): 594 more_info: Optional[LayoutSectionsModel] = Field(default=None, alias="moreInfo") 595 top_panel: Optional[LayoutSectionsModel] = Field(default=None, alias="topPanel")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
598class LayoutContentModel(BaseModel): 599 basic: Optional[BasicLayoutModel] = Field(default=None, alias="basic")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
602class CreateLayoutRequestModel(BaseModel): 603 content: LayoutContentModel = Field(alias="content") 604 domain_id: str = Field(alias="domainId") 605 name: str = Field(alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
608class GetLayoutResponseModel(BaseModel): 609 content: LayoutContentModel = Field(alias="content") 610 layout_arn: str = Field(alias="layoutArn") 611 layout_id: str = Field(alias="layoutId") 612 name: str = Field(alias="name") 613 tags: Dict[str, str] = Field(alias="tags") 614 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
617class UpdateLayoutRequestModel(BaseModel): 618 domain_id: str = Field(alias="domainId") 619 layout_id: str = Field(alias="layoutId") 620 content: Optional[LayoutContentModel] = Field(default=None, alias="content") 621 name: Optional[str] = Field(default=None, alias="name")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs