mypydantic.models.connectparticipant
1# Model Generated: Thu Mar 2 21:56:17 2023 2 3from __future__ import annotations 4 5from typing import Dict, List, Literal, Optional, Sequence 6 7from pydantic import Field 8 9from mypydantic.models.base_model import BaseModel 10 11 12class AttachmentItemModel(BaseModel): 13 content_type: Optional[str] = Field(default=None, alias="ContentType") 14 attachment_id: Optional[str] = Field(default=None, alias="AttachmentId") 15 attachment_name: Optional[str] = Field(default=None, alias="AttachmentName") 16 status: Optional[Literal["APPROVED", "IN_PROGRESS", "REJECTED"]] = Field( 17 default=None, alias="Status" 18 ) 19 20 21class CompleteAttachmentUploadRequestModel(BaseModel): 22 attachment_ids: Sequence[str] = Field(alias="AttachmentIds") 23 client_token: str = Field(alias="ClientToken") 24 connection_token: str = Field(alias="ConnectionToken") 25 26 27class ConnectionCredentialsModel(BaseModel): 28 connection_token: Optional[str] = Field(default=None, alias="ConnectionToken") 29 expiry: Optional[str] = Field(default=None, alias="Expiry") 30 31 32class CreateParticipantConnectionRequestModel(BaseModel): 33 participant_token: str = Field(alias="ParticipantToken") 34 type: Optional[Sequence[Literal["CONNECTION_CREDENTIALS", "WEBSOCKET"]]] = Field( 35 default=None, alias="Type" 36 ) 37 connect_participant: Optional[bool] = Field( 38 default=None, alias="ConnectParticipant" 39 ) 40 41 42class ResponseMetadataModel(BaseModel): 43 request_id: str = Field(alias="RequestId") 44 host_id: str = Field(alias="HostId") 45 http_status_code: int = Field(alias="HTTPStatusCode") 46 http_headers: Dict[str, str] = Field(alias="HTTPHeaders") 47 retry_attempts: int = Field(alias="RetryAttempts") 48 49 50class WebsocketModel(BaseModel): 51 url: Optional[str] = Field(default=None, alias="Url") 52 connection_expiry: Optional[str] = Field(default=None, alias="ConnectionExpiry") 53 54 55class DisconnectParticipantRequestModel(BaseModel): 56 connection_token: str = Field(alias="ConnectionToken") 57 client_token: Optional[str] = Field(default=None, alias="ClientToken") 58 59 60class GetAttachmentRequestModel(BaseModel): 61 attachment_id: str = Field(alias="AttachmentId") 62 connection_token: str = Field(alias="ConnectionToken") 63 64 65class StartPositionModel(BaseModel): 66 id: Optional[str] = Field(default=None, alias="Id") 67 absolute_time: Optional[str] = Field(default=None, alias="AbsoluteTime") 68 most_recent: Optional[int] = Field(default=None, alias="MostRecent") 69 70 71class ReceiptModel(BaseModel): 72 delivered_timestamp: Optional[str] = Field(default=None, alias="DeliveredTimestamp") 73 read_timestamp: Optional[str] = Field(default=None, alias="ReadTimestamp") 74 recipient_participant_id: Optional[str] = Field( 75 default=None, alias="RecipientParticipantId" 76 ) 77 78 79class SendEventRequestModel(BaseModel): 80 content_type: str = Field(alias="ContentType") 81 connection_token: str = Field(alias="ConnectionToken") 82 content: Optional[str] = Field(default=None, alias="Content") 83 client_token: Optional[str] = Field(default=None, alias="ClientToken") 84 85 86class SendMessageRequestModel(BaseModel): 87 content_type: str = Field(alias="ContentType") 88 content: str = Field(alias="Content") 89 connection_token: str = Field(alias="ConnectionToken") 90 client_token: Optional[str] = Field(default=None, alias="ClientToken") 91 92 93class StartAttachmentUploadRequestModel(BaseModel): 94 content_type: str = Field(alias="ContentType") 95 attachment_size_in_bytes: int = Field(alias="AttachmentSizeInBytes") 96 attachment_name: str = Field(alias="AttachmentName") 97 client_token: str = Field(alias="ClientToken") 98 connection_token: str = Field(alias="ConnectionToken") 99 100 101class UploadMetadataModel(BaseModel): 102 url: Optional[str] = Field(default=None, alias="Url") 103 url_expiry: Optional[str] = Field(default=None, alias="UrlExpiry") 104 headers_to_include: Optional[Dict[str, str]] = Field( 105 default=None, alias="HeadersToInclude" 106 ) 107 108 109class GetAttachmentResponseModel(BaseModel): 110 url: str = Field(alias="Url") 111 url_expiry: str = Field(alias="UrlExpiry") 112 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 113 114 115class SendEventResponseModel(BaseModel): 116 id: str = Field(alias="Id") 117 absolute_time: str = Field(alias="AbsoluteTime") 118 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 119 120 121class SendMessageResponseModel(BaseModel): 122 id: str = Field(alias="Id") 123 absolute_time: str = Field(alias="AbsoluteTime") 124 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 125 126 127class CreateParticipantConnectionResponseModel(BaseModel): 128 websocket: WebsocketModel = Field(alias="Websocket") 129 connection_credentials: ConnectionCredentialsModel = Field( 130 alias="ConnectionCredentials" 131 ) 132 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 133 134 135class GetTranscriptRequestModel(BaseModel): 136 connection_token: str = Field(alias="ConnectionToken") 137 contact_id: Optional[str] = Field(default=None, alias="ContactId") 138 max_results: Optional[int] = Field(default=None, alias="MaxResults") 139 next_token: Optional[str] = Field(default=None, alias="NextToken") 140 scan_direction: Optional[Literal["BACKWARD", "FORWARD"]] = Field( 141 default=None, alias="ScanDirection" 142 ) 143 sort_order: Optional[Literal["ASCENDING", "DESCENDING"]] = Field( 144 default=None, alias="SortOrder" 145 ) 146 start_position: Optional[StartPositionModel] = Field( 147 default=None, alias="StartPosition" 148 ) 149 150 151class MessageMetadataModel(BaseModel): 152 message_id: Optional[str] = Field(default=None, alias="MessageId") 153 receipts: Optional[List[ReceiptModel]] = Field(default=None, alias="Receipts") 154 155 156class StartAttachmentUploadResponseModel(BaseModel): 157 attachment_id: str = Field(alias="AttachmentId") 158 upload_metadata: UploadMetadataModel = Field(alias="UploadMetadata") 159 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata") 160 161 162class ItemModel(BaseModel): 163 absolute_time: Optional[str] = Field(default=None, alias="AbsoluteTime") 164 content: Optional[str] = Field(default=None, alias="Content") 165 content_type: Optional[str] = Field(default=None, alias="ContentType") 166 id: Optional[str] = Field(default=None, alias="Id") 167 type: Optional[ 168 Literal[ 169 "ATTACHMENT", 170 "CHAT_ENDED", 171 "CONNECTION_ACK", 172 "EVENT", 173 "MESSAGE", 174 "MESSAGE_DELIVERED", 175 "MESSAGE_READ", 176 "PARTICIPANT_JOINED", 177 "PARTICIPANT_LEFT", 178 "TRANSFER_FAILED", 179 "TRANSFER_SUCCEEDED", 180 "TYPING", 181 ] 182 ] = Field(default=None, alias="Type") 183 participant_id: Optional[str] = Field(default=None, alias="ParticipantId") 184 display_name: Optional[str] = Field(default=None, alias="DisplayName") 185 participant_role: Optional[Literal["AGENT", "CUSTOMER", "SYSTEM"]] = Field( 186 default=None, alias="ParticipantRole" 187 ) 188 attachments: Optional[List[AttachmentItemModel]] = Field( 189 default=None, alias="Attachments" 190 ) 191 message_metadata: Optional[MessageMetadataModel] = Field( 192 default=None, alias="MessageMetadata" 193 ) 194 related_contact_id: Optional[str] = Field(default=None, alias="RelatedContactId") 195 contact_id: Optional[str] = Field(default=None, alias="ContactId") 196 197 198class GetTranscriptResponseModel(BaseModel): 199 initial_contact_id: str = Field(alias="InitialContactId") 200 transcript: List[ItemModel] = Field(alias="Transcript") 201 next_token: str = Field(alias="NextToken") 202 response_metadata: ResponseMetadataModel = Field(alias="ResponseMetadata")
13class AttachmentItemModel(BaseModel): 14 content_type: Optional[str] = Field(default=None, alias="ContentType") 15 attachment_id: Optional[str] = Field(default=None, alias="AttachmentId") 16 attachment_name: Optional[str] = Field(default=None, alias="AttachmentName") 17 status: Optional[Literal["APPROVED", "IN_PROGRESS", "REJECTED"]] = Field( 18 default=None, alias="Status" 19 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
22class CompleteAttachmentUploadRequestModel(BaseModel): 23 attachment_ids: Sequence[str] = Field(alias="AttachmentIds") 24 client_token: str = Field(alias="ClientToken") 25 connection_token: str = Field(alias="ConnectionToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
28class ConnectionCredentialsModel(BaseModel): 29 connection_token: Optional[str] = Field(default=None, alias="ConnectionToken") 30 expiry: Optional[str] = Field(default=None, alias="Expiry")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
33class CreateParticipantConnectionRequestModel(BaseModel): 34 participant_token: str = Field(alias="ParticipantToken") 35 type: Optional[Sequence[Literal["CONNECTION_CREDENTIALS", "WEBSOCKET"]]] = Field( 36 default=None, alias="Type" 37 ) 38 connect_participant: Optional[bool] = Field( 39 default=None, alias="ConnectParticipant" 40 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
43class ResponseMetadataModel(BaseModel): 44 request_id: str = Field(alias="RequestId") 45 host_id: str = Field(alias="HostId") 46 http_status_code: int = Field(alias="HTTPStatusCode") 47 http_headers: Dict[str, str] = Field(alias="HTTPHeaders") 48 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
51class WebsocketModel(BaseModel): 52 url: Optional[str] = Field(default=None, alias="Url") 53 connection_expiry: Optional[str] = Field(default=None, alias="ConnectionExpiry")
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 DisconnectParticipantRequestModel(BaseModel): 57 connection_token: str = Field(alias="ConnectionToken") 58 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
61class GetAttachmentRequestModel(BaseModel): 62 attachment_id: str = Field(alias="AttachmentId") 63 connection_token: str = Field(alias="ConnectionToken")
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 StartPositionModel(BaseModel): 67 id: Optional[str] = Field(default=None, alias="Id") 68 absolute_time: Optional[str] = Field(default=None, alias="AbsoluteTime") 69 most_recent: Optional[int] = Field(default=None, alias="MostRecent")
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 ReceiptModel(BaseModel): 73 delivered_timestamp: Optional[str] = Field(default=None, alias="DeliveredTimestamp") 74 read_timestamp: Optional[str] = Field(default=None, alias="ReadTimestamp") 75 recipient_participant_id: Optional[str] = Field( 76 default=None, alias="RecipientParticipantId" 77 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
80class SendEventRequestModel(BaseModel): 81 content_type: str = Field(alias="ContentType") 82 connection_token: str = Field(alias="ConnectionToken") 83 content: Optional[str] = Field(default=None, alias="Content") 84 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
87class SendMessageRequestModel(BaseModel): 88 content_type: str = Field(alias="ContentType") 89 content: str = Field(alias="Content") 90 connection_token: str = Field(alias="ConnectionToken") 91 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
94class StartAttachmentUploadRequestModel(BaseModel): 95 content_type: str = Field(alias="ContentType") 96 attachment_size_in_bytes: int = Field(alias="AttachmentSizeInBytes") 97 attachment_name: str = Field(alias="AttachmentName") 98 client_token: str = Field(alias="ClientToken") 99 connection_token: str = Field(alias="ConnectionToken")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
102class UploadMetadataModel(BaseModel): 103 url: Optional[str] = Field(default=None, alias="Url") 104 url_expiry: Optional[str] = Field(default=None, alias="UrlExpiry") 105 headers_to_include: Optional[Dict[str, str]] = Field( 106 default=None, alias="HeadersToInclude" 107 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
110class GetAttachmentResponseModel(BaseModel): 111 url: str = Field(alias="Url") 112 url_expiry: str = Field(alias="UrlExpiry") 113 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
116class SendEventResponseModel(BaseModel): 117 id: str = Field(alias="Id") 118 absolute_time: str = Field(alias="AbsoluteTime") 119 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
122class SendMessageResponseModel(BaseModel): 123 id: str = Field(alias="Id") 124 absolute_time: str = Field(alias="AbsoluteTime") 125 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
128class CreateParticipantConnectionResponseModel(BaseModel): 129 websocket: WebsocketModel = Field(alias="Websocket") 130 connection_credentials: ConnectionCredentialsModel = Field( 131 alias="ConnectionCredentials" 132 ) 133 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
136class GetTranscriptRequestModel(BaseModel): 137 connection_token: str = Field(alias="ConnectionToken") 138 contact_id: Optional[str] = Field(default=None, alias="ContactId") 139 max_results: Optional[int] = Field(default=None, alias="MaxResults") 140 next_token: Optional[str] = Field(default=None, alias="NextToken") 141 scan_direction: Optional[Literal["BACKWARD", "FORWARD"]] = Field( 142 default=None, alias="ScanDirection" 143 ) 144 sort_order: Optional[Literal["ASCENDING", "DESCENDING"]] = Field( 145 default=None, alias="SortOrder" 146 ) 147 start_position: Optional[StartPositionModel] = Field( 148 default=None, alias="StartPosition" 149 )
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
152class MessageMetadataModel(BaseModel): 153 message_id: Optional[str] = Field(default=None, alias="MessageId") 154 receipts: Optional[List[ReceiptModel]] = Field(default=None, alias="Receipts")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
157class StartAttachmentUploadResponseModel(BaseModel): 158 attachment_id: str = Field(alias="AttachmentId") 159 upload_metadata: UploadMetadataModel = Field(alias="UploadMetadata") 160 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
163class ItemModel(BaseModel): 164 absolute_time: Optional[str] = Field(default=None, alias="AbsoluteTime") 165 content: Optional[str] = Field(default=None, alias="Content") 166 content_type: Optional[str] = Field(default=None, alias="ContentType") 167 id: Optional[str] = Field(default=None, alias="Id") 168 type: Optional[ 169 Literal[ 170 "ATTACHMENT", 171 "CHAT_ENDED", 172 "CONNECTION_ACK", 173 "EVENT", 174 "MESSAGE", 175 "MESSAGE_DELIVERED", 176 "MESSAGE_READ", 177 "PARTICIPANT_JOINED", 178 "PARTICIPANT_LEFT", 179 "TRANSFER_FAILED", 180 "TRANSFER_SUCCEEDED", 181 "TYPING", 182 ] 183 ] = Field(default=None, alias="Type") 184 participant_id: Optional[str] = Field(default=None, alias="ParticipantId") 185 display_name: Optional[str] = Field(default=None, alias="DisplayName") 186 participant_role: Optional[Literal["AGENT", "CUSTOMER", "SYSTEM"]] = Field( 187 default=None, alias="ParticipantRole" 188 ) 189 attachments: Optional[List[AttachmentItemModel]] = Field( 190 default=None, alias="Attachments" 191 ) 192 message_metadata: Optional[MessageMetadataModel] = Field( 193 default=None, alias="MessageMetadata" 194 ) 195 related_contact_id: Optional[str] = Field(default=None, alias="RelatedContactId") 196 contact_id: Optional[str] = Field(default=None, alias="ContactId")
Inherited Members
- pydantic.main.BaseModel
- dict
- json
- parse_obj
- parse_raw
- parse_file
- from_orm
- construct
- copy
- schema
- schema_json
- validate
- update_forward_refs
199class GetTranscriptResponseModel(BaseModel): 200 initial_contact_id: str = Field(alias="InitialContactId") 201 transcript: List[ItemModel] = Field(alias="Transcript") 202 next_token: str = Field(alias="NextToken") 203 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