ghl-models 0.3.1

//! `conversations` data models for GoHighLevel API V2 (44 types).
//!
//! Generated from HighLevel's official OpenAPI spec for the
//! **Conversations** module. Every endpoint that uses these types, with its
//! parameters, required scopes and enum values, is documented in the
//! [`conversations` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/conversations.md).
//!
//! Enable with `features = ["conversations"]`.
// @generated by xtask/generate_models.py — do not edit by hand.
// Source: https://github.com/GoHighLevel/highlevel-api-docs
// Doc comments are HighLevel's own field descriptions, reflowed verbatim, so
// they aren't held to rustdoc's markdown conventions.
#![allow(
    missing_docs,
    clippy::doc_lazy_continuation,
    clippy::doc_overindented_list_items
)]

use serde::{Deserialize, Serialize};

/// `AddMessageAttachmentsDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AddMessageAttachmentsDto {
    /// Array of attachment URLs to set on the message (replaces existing). Maximum 5 URLs.
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,
}

/// `CallDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CallDataDTO {
    /// Phone number of the receiver
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub to: Option<String>,
    /// Phone number of the dialer
    #[serde(rename = "from", default, skip_serializing_if = "Option::is_none")]
    pub from_: Option<String>,
    /// Call status
    /// Allowed values: `pending`, `completed`, `answered`, `busy`, `no-answer`, `failed`,
    /// `canceled`, `voicemail`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
}

/// `CancelScheduledResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CancelScheduledResponseDto {
    /// HTTP Status code of the request
    /// Required by the API.
    pub status: f64,
    /// Error message of the request
    /// Required by the API.
    pub message: String,
}

/// `CompleteFileUploadDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CompleteFileUploadDto {
    /// Upload ID from request response
    /// Required by the API.
    #[serde(rename = "uploadId")]
    pub upload_id: String,
    /// File path from request response
    /// Required by the API.
    #[serde(rename = "filePath")]
    pub file_path: String,
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Conversation ID
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Original filename (for response mapping)
    /// Required by the API.
    pub filename: String,
}

/// `CompleteFileUploadResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CompleteFileUploadResponseDto {
    /// Map of filename to public URL
    /// Required by the API.
    #[serde(rename = "uploadedFiles")]
    pub uploaded_files: serde_json::Value,
    /// File metadata
    /// Required by the API.
    pub metadata: serde_json::Value,
}

/// `ConversationCreateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ConversationCreateResponseDto {
    /// Unique identifier for the conversation
    /// Required by the API.
    pub id: String,
    /// Date when the conversation was last updated
    /// Required by the API.
    #[serde(rename = "dateUpdated")]
    pub date_updated: String,
    /// Date when the conversation was created
    /// Required by the API.
    #[serde(rename = "dateAdded")]
    pub date_added: String,
    /// Flag indicating if this conversation has been deleted
    /// Required by the API.
    pub deleted: bool,
    /// Unique identifier of the contact associated with this conversation
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Unique identifier of the business location where this conversation takes place
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Date of the last message in the conversation
    /// Required by the API.
    #[serde(rename = "lastMessageDate")]
    pub last_message_date: String,
    /// Unique identifier of the team member assigned to this conversation
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
}

/// `ConversationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ConversationDto {
    /// Contact ID as string
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Contact ID as string
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Assigned User ID as string
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// User ID as string
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// Last message body as string
    #[serde(
        rename = "lastMessageBody",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_message_body: Option<String>,
    /// Last message date as UTC
    #[serde(
        rename = "lastMessageDate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_message_date: Option<String>,
    /// Type of the last message sent/received in the conversation.
    /// Allowed values: `TYPE_CALL`, `TYPE_SMS`, `TYPE_RCS`, `TYPE_EMAIL`,
    /// `TYPE_SMS_REVIEW_REQUEST`, `TYPE_WEBCHAT`, `TYPE_SMS_NO_SHOW_REQUEST`,
    /// `TYPE_CAMPAIGN_SMS`, `TYPE_CAMPAIGN_CALL`, `TYPE_CAMPAIGN_EMAIL`,
    /// `TYPE_CAMPAIGN_VOICEMAIL`, `TYPE_FACEBOOK`.
    #[serde(
        rename = "lastMessageType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_message_type: Option<String>,
    /// Count of unread messages in the conversation
    #[serde(
        rename = "unreadCount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub unread_count: Option<f64>,
    /// Inbox status of the conversation.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub inbox: Option<bool>,
    /// Starred status of the conversation.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub starred: Option<bool>,
    /// Deleted status of the conversation.
    /// Required by the API.
    pub deleted: bool,
}

/// `ConversationSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ConversationSchema {
    /// Conversation Id
    /// Required by the API.
    pub id: String,
    /// Contact Id
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Content of the most recent message in the conversation
    /// Required by the API.
    #[serde(rename = "lastMessageBody")]
    pub last_message_body: String,
    /// Channel/type of the most recent message (SMS, Email, Call, etc)
    /// Allowed values: `TYPE_CALL`, `TYPE_SMS`, `TYPE_RCS`, `TYPE_EMAIL`,
    /// `TYPE_SMS_REVIEW_REQUEST`, `TYPE_WEBCHAT`, `TYPE_SMS_NO_SHOW_REQUEST`,
    /// `TYPE_CAMPAIGN_SMS`, `TYPE_CAMPAIGN_CALL`, `TYPE_CAMPAIGN_EMAIL`,
    /// `TYPE_CAMPAIGN_VOICEMAIL`, `TYPE_FACEBOOK`.
    /// Required by the API.
    #[serde(rename = "lastMessageType")]
    pub last_message_type: String,
    /// Primary channel/type of the conversation (Phone, Email, etc)
    /// Allowed values: `TYPE_PHONE`, `TYPE_EMAIL`, `TYPE_FB_MESSENGER`, `TYPE_REVIEW`,
    /// `TYPE_GROUP_SMS`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Number of unread messages in this conversation
    /// Required by the API.
    #[serde(rename = "unreadCount")]
    pub unread_count: f64,
    /// Complete name of the contact (first and last name)
    /// Required by the API.
    #[serde(rename = "fullName")]
    pub full_name: String,
    /// Alternative display name for the contact - used when full name is not available
    /// Required by the API.
    #[serde(rename = "contactName")]
    pub contact_name: String,
    /// Primary email address of the contact
    /// Required by the API.
    pub email: String,
    /// Primary phone number of the contact
    /// Required by the API.
    pub phone: String,
}

/// `CreateConversationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateConversationDto {
    /// Location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Contact ID as string
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
}

/// `CreateConversationSuccessResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateConversationSuccessResponse {
    /// Indicates whether the API request was successful.
    /// Required by the API.
    pub success: bool,
    /// Conversation data of the provided conversation ID.
    /// Required by the API.
    pub conversation: ConversationCreateResponseDto,
}

/// `CreateCustomSubtypeDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCustomSubtypeDto {
    /// Name of the custom subtype (max 100 characters)
    /// Required by the API.
    pub name: String,
    /// Description of the custom subtype (max 100 characters)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Communication channel
    /// Allowed values: `email`, `sms`.
    /// Required by the API.
    pub channel: String,
    /// Language code
    /// Required by the API.
    pub language: String,
}

/// `CreateLiveChatMessageFeedbackResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateLiveChatMessageFeedbackResponse {
    /// Required by the API.
    pub success: bool,
}

/// `DeleteConversationSuccessfulResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteConversationSuccessfulResponse {
    /// Boolean value as the API response.
    /// Required by the API.
    pub success: bool,
}

/// `ErrorDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ErrorDto {
    /// Error Code
    /// Required by the API.
    pub code: String,
    /// Error Type
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Error Message
    /// Required by the API.
    pub message: String,
}

/// `ExportMessagesResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ExportMessagesResponseDto {
    /// Array of messages
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub messages: Vec<GetMessageResponseDto>,
    /// Cursor for fetching next page. Null if no more results.
    #[serde(
        rename = "nextCursor",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub next_cursor: Option<String>,
    /// Total number of messages matching the query
    /// Required by the API.
    pub total: f64,
}

/// `ForwardConfigDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ForwardConfigDto {
    /// Specify if this is a forwarded email
    /// Required by the API.
    #[serde(rename = "isForwarded")]
    pub is_forwarded: bool,
    /// Specify if forwarding the whole thread or just a single email
    #[serde(
        rename = "forwardWholeThread",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub forward_whole_thread: Option<bool>,
    /// Message ID of the email thread being forwarded (source) - REQUIRED for forwarding
    #[serde(rename = "messageId", default, skip_serializing_if = "Option::is_none")]
    pub message_id: Option<String>,
    /// Email Message ID of the specific email being forwarded (source) - Required for single
    /// email forward, ignored for thread forward
    #[serde(
        rename = "emailMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_message_id: Option<String>,
    /// Contact ID where the forwarded email originated from (source) - Auto-populated if not
    /// provided
    #[serde(
        rename = "sourceContactId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_contact_id: Option<String>,
    /// Conversation ID where the forwarded email originated from (source) - Auto-populated if
    /// not provided
    #[serde(
        rename = "sourceConversationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_conversation_id: Option<String>,
    /// Email address to forward to (destination)
    #[serde(rename = "toEmail", default, skip_serializing_if = "Option::is_none")]
    pub to_email: Option<String>,
    /// Contact ID of recipient when forwarding (destination)
    #[serde(
        rename = "recipientContactId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recipient_contact_id: Option<String>,
    /// Conversation ID of recipient when forwarding (destination)
    #[serde(
        rename = "recipientConversationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recipient_conversation_id: Option<String>,
}

/// `ForwardResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ForwardResponseDto {
    /// Whether the entire thread was forwarded
    #[serde(
        rename = "forwardWholeThread",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub forward_whole_thread: Option<bool>,
    /// Message ID of the forwarded message (source)
    #[serde(rename = "messageId", default, skip_serializing_if = "Option::is_none")]
    pub message_id: Option<String>,
    /// Email Message ID of the forwarded email (source)
    #[serde(
        rename = "emailMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_message_id: Option<String>,
    /// Contact ID where the forwarded email originated from (source)
    #[serde(
        rename = "sourceContactId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_contact_id: Option<String>,
    /// Conversation ID where the forwarded email originated from (source)
    #[serde(
        rename = "sourceConversationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_conversation_id: Option<String>,
    /// Email address the message was forwarded to (destination)
    #[serde(
        rename = "forwardToEmail",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub forward_to_email: Option<String>,
    /// Contact ID of the recipient of the forwarded email (destination)
    #[serde(
        rename = "recipientContactId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recipient_contact_id: Option<String>,
    /// Conversation ID of the recipient of the forwarded email (destination)
    #[serde(
        rename = "recipientConversationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recipient_conversation_id: Option<String>,
}

/// `GetConversationByIdResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetConversationByIdResponse {
    /// Unique identifier of the contact associated with this conversation
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Unique identifier of the business location where this conversation takes place
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Flag indicating if this conversation has been moved to trash/deleted
    /// Required by the API.
    pub deleted: bool,
    /// Flag indicating if this conversation is currently in the main inbox view
    /// Required by the API.
    pub inbox: bool,
    /// Communication channel type for this conversation: 1 (Phone), 2 (Email), 3 (Facebook
    /// Messenger), 4 (Review), 5 (Group SMS), 6 (Internal Chat - coming soon)
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: f64,
    /// Number of messages in this conversation that have not been read by the user
    /// Required by the API.
    #[serde(rename = "unreadCount")]
    pub unread_count: f64,
    /// Unique identifier of the team member currently responsible for handling this
    /// conversation
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Unique identifier for this specific conversation thread
    /// Required by the API.
    pub id: String,
    /// Flag indicating if this conversation has been marked as important/starred by the user
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub starred: Option<bool>,
}

/// `GetConversationSuccessfulResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetConversationSuccessfulResponse {
    /// Boolean value as the API response.
    /// Required by the API.
    pub success: bool,
    /// Conversation data of the provided conversation ID.
    /// Required by the API.
    pub conversation: ConversationDto,
}

/// `GetEmailMessageResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetEmailMessageResponseDto {
    /// Required by the API.
    pub id: String,
    /// External Id
    #[serde(rename = "altId", default, skip_serializing_if = "Option::is_none")]
    pub alt_id: Option<String>,
    /// Message Id or thread Id
    /// Required by the API.
    #[serde(rename = "threadId")]
    pub thread_id: String,
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Required by the API.
    #[serde(rename = "dateAdded")]
    pub date_added: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    /// Required by the API.
    pub body: String,
    /// Allowed values: `inbound`, `outbound`.
    /// Required by the API.
    pub direction: String,
    /// Allowed values: `pending`, `scheduled`, `sent`, `delivered`, `read`, `undelivered`,
    /// `connected`, `failed`, `opened`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Required by the API.
    #[serde(rename = "contentType")]
    pub content_type: String,
    /// An array of attachment URLs.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub provider: Option<String>,
    /// Name and Email Id of the sender
    /// Required by the API.
    #[serde(rename = "from")]
    pub from_: String,
    /// List of email Ids of the receivers
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub to: Vec<String>,
    /// List of email Ids of the people in the cc field
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub cc: Vec<String>,
    /// List of email Ids of the people in the bcc field
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub bcc: Vec<String>,
    /// In case of reply, email message Id of the reply to email
    #[serde(
        rename = "replyToMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub reply_to_message_id: Option<String>,
    /// Email source
    /// Allowed values: `workflow`, `bulk_actions`, `campaign`, `api`, `app`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// Conversation provider ID
    #[serde(
        rename = "conversationProviderId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub conversation_provider_id: Option<String>,
}

/// `GetMessageResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetMessageResponseDto {
    /// Required by the API.
    pub id: String,
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: f64,
    /// Type of the message as a string
    /// Allowed values: `TYPE_CALL`, `TYPE_SMS`, `TYPE_RCS`, `TYPE_EMAIL`,
    /// `TYPE_SMS_REVIEW_REQUEST`, `TYPE_WEBCHAT`, `TYPE_SMS_NO_SHOW_REQUEST`,
    /// `TYPE_CAMPAIGN_SMS`, `TYPE_CAMPAIGN_CALL`, `TYPE_CAMPAIGN_EMAIL`,
    /// `TYPE_CAMPAIGN_VOICEMAIL`, `TYPE_FACEBOOK`.
    /// Required by the API.
    #[serde(rename = "messageType")]
    pub message_type: String,
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Required by the API.
    #[serde(rename = "dateAdded")]
    pub date_added: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// Allowed values: `inbound`, `outbound`.
    /// Required by the API.
    pub direction: String,
    /// Allowed values: `connected`, `delivered`, `failed`, `opened`, `pending`, `read`,
    /// `scheduled`, `sent`, `undelivered`, `clicked`, `opt_out`, `queued`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// Required by the API.
    #[serde(rename = "contentType")]
    pub content_type: String,
    /// An array of attachment URLs. Attachments will be empty for Call and Voicemails, type 1
    /// and 10. Please use get call recording API to fetch call recording and voicemails.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<MessageMeta>,
    /// Message source
    /// Allowed values: `workflow`, `bulk_actions`, `campaign`, `api`, `app`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// User Id
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// Conversation Provider Id
    #[serde(
        rename = "conversationProviderId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub conversation_provider_id: Option<String>,
    /// Chat Widget Id
    #[serde(
        rename = "chatWidgetId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub chat_widget_id: Option<String>,
}

/// `GetMessageTranscriptionResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetMessageTranscriptionResponseDto {
    /// Media channel describes the user interaction channel
    /// Required by the API.
    #[serde(rename = "mediaChannel")]
    pub media_channel: f64,
    /// Index of the sentence in the transcription
    /// Required by the API.
    #[serde(rename = "sentenceIndex")]
    pub sentence_index: f64,
    /// Start time of the sentence in milliseconds
    /// Required by the API.
    #[serde(rename = "startTime")]
    pub start_time: f64,
    /// End time of the sentence in milliseconds
    /// Required by the API.
    #[serde(rename = "endTime")]
    pub end_time: f64,
    /// Transcript of the sentence
    /// Required by the API.
    pub transcript: String,
    /// Confidence of the transcription
    /// Required by the API.
    pub confidence: f64,
}

/// `GetMessagesByConversationResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetMessagesByConversationResponseDto {
    /// Id of the last message in the messages array
    /// Required by the API.
    #[serde(rename = "lastMessageId")]
    pub last_message_id: String,
    /// Next page value true indicates only 20 message is in the response. Rest of the messages
    /// are in the next page. Please use the lastMessageId value in the query to get the next
    /// page messages
    /// Required by the API.
    #[serde(rename = "nextPage")]
    pub next_page: bool,
    /// Array of messages
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub messages: Vec<GetMessageResponseDto>,
}

/// `InitiateFileUploadDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct InitiateFileUploadDto {
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Conversation ID
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Original filename with extension
    /// Required by the API.
    pub filename: String,
    /// MIME type of the file
    /// Required by the API.
    #[serde(rename = "contentType")]
    pub content_type: String,
    /// File size in bytes (optional, for pre-validation)
    #[serde(rename = "fileSize", default, skip_serializing_if = "Option::is_none")]
    pub file_size: Option<f64>,
    /// Channel type for size limits (WHATSAPP for 100MB limit, others for 5MB)
    /// Required by the API.
    pub channel: String,
}

/// `InitiateFileUploadResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct InitiateFileUploadResponseDto {
    /// Signed URL for direct upload to GCS. Use PUT request with file content.
    /// Required by the API.
    #[serde(rename = "uploadUrl")]
    pub upload_url: String,
    /// Unique upload ID for tracking and completing the upload
    /// Required by the API.
    #[serde(rename = "uploadId")]
    pub upload_id: String,
    /// File path in GCS bucket (needed for confirmation endpoint)
    /// Required by the API.
    #[serde(rename = "filePath")]
    pub file_path: String,
    /// URL expiration timestamp (Unix milliseconds)
    /// Required by the API.
    #[serde(rename = "expiresAt")]
    pub expires_at: f64,
    /// Maximum allowed file size in bytes
    /// Required by the API.
    #[serde(rename = "maxFileSize")]
    pub max_file_size: f64,
}

/// `MessageMeta` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct MessageMeta {
    /// Call duration in seconds
    #[serde(
        rename = "callDuration",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub call_duration: Option<String>,
    /// Call status - can be pending, completed, answered, busy, no-answer, failed, canceled, or
    /// voicemail
    /// Allowed values: `pending`, `completed`, `answered`, `busy`, `no-answer`, `failed`,
    /// `canceled`, `voicemail`.
    #[serde(
        rename = "callStatus",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub call_status: Option<String>,
    /// meta will contain email, for message type 3 (email). messageIds is list of all email
    /// message ids under the message thread
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<serde_json::Value>,
}

/// `ProcessMessageBodyDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProcessMessageBodyDto {
    /// Message Type
    /// Allowed values: `SMS`, `RCS`, `Email`, `WhatsApp`, `GMB`, `IG`, `FB`, `Custom`,
    /// `WebChat`, `Live_Chat`, `Call`, `IVR_Call`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Array of attachments
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,
    /// Message Body
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Conversation Id
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Contact Id
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Conversation Provider Id
    /// Required by the API.
    #[serde(rename = "conversationProviderId")]
    pub conversation_provider_id: String,
    /// HTML Body of Email
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub html: Option<String>,
    /// Subject of the Email
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    /// Email address to send from. This field is associated with the contact record and cannot
    /// be dynamically changed.
    #[serde(rename = "emailFrom", default, skip_serializing_if = "Option::is_none")]
    pub email_from: Option<String>,
    /// Recipient email address. This field is associated with the contact record and cannot be
    /// dynamically changed.
    #[serde(rename = "emailTo", default, skip_serializing_if = "Option::is_none")]
    pub email_to: Option<String>,
    /// List of email address to CC
    #[serde(rename = "emailCc", default, skip_serializing_if = "Vec::is_empty")]
    pub email_cc: Vec<String>,
    /// List of email address to BCC
    #[serde(rename = "emailBcc", default, skip_serializing_if = "Vec::is_empty")]
    pub email_bcc: Vec<String>,
    /// Send the email message id for which this email should be threaded. This is for replying
    /// to a specific email
    #[serde(
        rename = "emailMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_message_id: Option<String>,
    /// external mail provider's message id
    #[serde(rename = "altId", default, skip_serializing_if = "Option::is_none")]
    pub alt_id: Option<String>,
    /// Message direction, if required can be set manually, default is outbound
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub direction: Option<serde_json::Value>,
    /// Date of the inbound message
    /// Format: date-time (ISO-8601 string).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub date: Option<String>,
    /// Phone call dialer and receiver information
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub call: Option<CallDataDTO>,
}

/// `ProcessMessageResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProcessMessageResponseDto {
    /// Required by the API.
    pub success: bool,
    /// Conversation ID.
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// This is the main Message ID
    /// Required by the API.
    #[serde(rename = "messageId")]
    pub message_id: String,
    /// Required by the API.
    pub message: String,
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Format: date-time (ISO-8601 string).
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    #[serde(
        rename = "emailMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_message_id: Option<String>,
}

/// `ProcessOutboundMessageBodyDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProcessOutboundMessageBodyDto {
    /// Message Type
    /// Allowed values: `Call`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Array of attachments
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,
    /// Conversation Id
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Conversation Provider Id
    /// Required by the API.
    #[serde(rename = "conversationProviderId")]
    pub conversation_provider_id: String,
    /// external mail provider's message id
    #[serde(rename = "altId", default, skip_serializing_if = "Option::is_none")]
    pub alt_id: Option<String>,
    /// Date of the outbound message
    /// Format: date-time (ISO-8601 string).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub date: Option<String>,
    /// Phone call dialer and receiver information
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub call: Option<CallDataDTO>,
}

/// `SendConversationResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendConversationResponseDto {
    /// The list of all conversations found for the given query
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub conversations: Vec<ConversationSchema>,
    /// Total Number of results found for the given query
    /// Required by the API.
    pub total: f64,
}

/// `SendMessageBodyDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendMessageBodyDto {
    /// Type of message being sent
    /// Allowed values: `SMS`, `RCS`, `Email`, `WhatsApp`, `IG`, `FB`, `Custom`, `Live_Chat`,
    /// `TIKTOK`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Type of message being sent
    /// Required by the API.
    #[serde(rename = "subType")]
    pub sub_type: serde_json::Value,
    /// ID of the contact receiving the message
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// ID of the associated appointment
    #[serde(
        rename = "appointmentId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub appointment_id: Option<String>,
    /// Array of attachment URLs
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<String>,
    /// Email address to send from
    #[serde(rename = "emailFrom", default, skip_serializing_if = "Option::is_none")]
    pub email_from: Option<String>,
    /// Array of CC email addresses
    #[serde(rename = "emailCc", default, skip_serializing_if = "Vec::is_empty")]
    pub email_cc: Vec<String>,
    /// Array of BCC email addresses
    #[serde(rename = "emailBcc", default, skip_serializing_if = "Vec::is_empty")]
    pub email_bcc: Vec<String>,
    /// HTML content of the message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub html: Option<String>,
    /// Text content of the message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Subject line for email messages
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    /// ID of message being replied to
    #[serde(
        rename = "replyMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub reply_message_id: Option<String>,
    /// ID of message template
    #[serde(
        rename = "templateId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub template_id: Option<String>,
    /// ID of message thread. For email messages, this is the message ID that contains multiple
    /// email messages in the thread
    #[serde(rename = "threadId", default, skip_serializing_if = "Option::is_none")]
    pub thread_id: Option<String>,
    /// UTC Timestamp (in seconds) at which the message should be scheduled
    #[serde(
        rename = "scheduledTimestamp",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub scheduled_timestamp: Option<f64>,
    /// ID of conversation provider
    #[serde(
        rename = "conversationProviderId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub conversation_provider_id: Option<String>,
    /// Email address to send to, if different from contact's primary email. This should be a
    /// valid email address associated with the contact.
    #[serde(rename = "emailTo", default, skip_serializing_if = "Option::is_none")]
    pub email_to: Option<String>,
    /// Custom subtype ID for email unsubscription preferences. Only applies to email messages.
    #[serde(
        rename = "customSubtypeId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub custom_subtype_id: Option<String>,
    /// Mode for email replies
    /// Allowed values: `reply`, `reply_all`.
    #[serde(
        rename = "emailReplyMode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_reply_mode: Option<String>,
    /// Phone number used as the sender number for outbound messages
    #[serde(
        rename = "fromNumber",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub from_number: Option<String>,
    /// Recipient phone number for outbound messages
    #[serde(rename = "toNumber", default, skip_serializing_if = "Option::is_none")]
    pub to_number: Option<String>,
    /// Forwarding configuration for emails
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub forward: Option<ForwardConfigDto>,
    /// Message status
    /// Allowed values: `delivered`, `failed`, `pending`, `read`.
    /// Required by the API.
    pub status: String,
    /// Whether the scheduled email uses native AI for the email scheduling
    #[serde(
        rename = "usesNativeSchedulingAi",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub uses_native_scheduling_ai: Option<bool>,
    /// Optimization period in hours (24h, 48h, or 72h)
    /// Allowed values: `24h`, `48h`, `72h`.
    #[serde(
        rename = "optimizationPeriod",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub optimization_period: Option<String>,
}

/// `SendMessageResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendMessageResponseDto {
    /// Conversation ID.
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// This contains the email message id (only for Email type). Use this ID to send inbound
    /// replies to GHL to create a threaded email.
    #[serde(
        rename = "emailMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_message_id: Option<String>,
    /// This is the main Message ID
    /// Required by the API.
    #[serde(rename = "messageId")]
    pub message_id: String,
    /// When sending via the GMB channel, we will be returning list of `messageIds` instead of
    /// single `messageId`.
    #[serde(rename = "messageIds", default, skip_serializing_if = "Vec::is_empty")]
    pub message_ids: Vec<String>,
    /// Additional response message when sending a workflow message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub msg: Option<String>,
    /// Optional metadata for forwarded email
    #[serde(
        rename = "forwardData",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub forward_data: Option<ForwardResponseDto>,
    /// Message status
    /// Allowed values: `delivered`, `failed`, `pending`, `read`.
    /// Required by the API.
    pub status: String,
}

/// `SendReviewReplyDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendReviewReplyDto {
    /// Conversation ID (must have reviewId)
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Review reply message text
    /// Required by the API.
    pub message: String,
}

/// `StartAfterArrayNumberSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StartAfterArrayNumberSchema {
    /// Search to begin after the specified date - should contain the sort value of the last
    /// document
    #[serde(
        rename = "startAfterDate",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub start_after_date: Vec<String>,
}

/// `StartAfterNumberSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StartAfterNumberSchema {
    /// Search to begin after the specified date - should contain the sort value of the last
    /// document
    #[serde(
        rename = "startAfterDate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub start_after_date: Option<f64>,
}

/// `SubscriptionActionDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SubscriptionActionDto {
    /// Type of subscription action
    /// Allowed values: `default`, `custom`, `resub_all`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Subscription type name (required for default types: "One on One")
    /// Allowed values: `One on One`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subtype_name: Option<String>,
    /// Custom subscription type ID (required for custom types)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subtype_id: Option<String>,
    /// Subscription status
    /// Allowed values: `subscribed`, `unsubscribed`.
    /// Required by the API.
    pub subtype_status: String,
}

/// `UpdateConversationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateConversationDto {
    /// Location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Count of unread messages in the conversation
    #[serde(
        rename = "unreadCount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub unread_count: Option<f64>,
    /// Starred status of the conversation.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub starred: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub feedback: Option<serde_json::Value>,
}

/// `UpdateCustomSubtypeDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCustomSubtypeDto {
    /// Name of the custom subtype (max 100 characters)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Description of the custom subtype (max 100 characters)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Whether the custom subtype is archived
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub archived: Option<bool>,
    /// Resubscription legal form ID (optional when archiving)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resubscription_legal_form_id: Option<String>,
}

/// `UpdateMessageStatusDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateMessageStatusDto {
    /// Message status
    /// Allowed values: `delivered`, `failed`, `pending`, `read`.
    /// Required by the API.
    pub status: String,
    /// Error object from the conversation provider
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<ErrorDto>,
    /// Email message Id
    #[serde(
        rename = "emailMessageId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub email_message_id: Option<String>,
    /// Email delivery status for additional email recipients.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub recipients: Vec<String>,
}

/// `UploadFilesDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UploadFilesDto {
    /// Conversation Id
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
    /// Contact Id
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Required by the API.
    #[serde(
        rename = "attachmentUrls",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub attachment_urls: Vec<String>,
    /// Twilio chat service SID for group SMS uploads
    #[serde(
        rename = "chatServiceSid",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub chat_service_sid: Option<String>,
    /// Flag to indicate group SMS upload flow. When true, only 1 file upload is allowed per
    /// request.
    #[serde(
        rename = "isGroupSms",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_group_sms: Option<String>,
}

/// `UploadFilesErrorResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UploadFilesErrorResponseDto {
    /// HTTP Status code of the request
    /// Allowed values: `400`, `413`, `415`.
    /// Required by the API.
    pub status: String,
    /// Error message of the request
    /// Required by the API.
    pub message: String,
}

/// `UploadFilesResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UploadFilesResponseDto {
    /// Required by the API.
    #[serde(rename = "uploadedFiles")]
    pub uploaded_files: serde_json::Value,
    /// Twilio media SIDs for group SMS (when isGroupSms=true)
    #[serde(
        rename = "twilioMediaSids",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub twilio_media_sids: Vec<String>,
}

/// `UserSubscriptionChangeDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UserSubscriptionChangeDto {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Contact Id
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Email address
    /// Required by the API.
    pub email: String,
    /// Subscription action details
    /// Required by the API.
    pub subscription_action: SubscriptionActionDto,
    /// Legal reason for the change (required only for resubscribe and resub_all actions)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub legal_reason: Option<String>,
    /// Legal description/details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub legal_description: Option<String>,
}

/// `UserTypingBody` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UserTypingBody {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Typing status
    /// Required by the API.
    #[serde(rename = "isTyping")]
    pub is_typing: String,
    /// visitorId is the Unique ID assigned to each Live chat visitor. visitorId will be added
    /// soon in <a
    /// href="https://highlevel.stoplight.io/docs/integrations/00c5ff21f0030-get-contact"
    /// target="_blank">GET Contact API</a>
    /// Required by the API.
    #[serde(rename = "visitorId")]
    pub visitor_id: String,
    /// Conversation Id
    /// Required by the API.
    #[serde(rename = "conversationId")]
    pub conversation_id: String,
}