ghl-models 0.4.1

//! `conversation-ai` data models for GoHighLevel API V3 (28 types).
//!
//! Generated from HighLevel's official OpenAPI spec for the
//! **Conversation Ai** module. Every endpoint that uses these types, with its
//! parameters, required scopes and enum values, is documented in the
//! [`conversation-ai` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/conversation-ai.md).
//!
//! Enable with `features = ["conversation-ai"]`.
// @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};

/// `ActionDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ActionDataDTO {
    /// Unique identifier for the action
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Name of the action
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Type of the action
    /// Allowed values: `triggerWorkflow`, `updateContactField`, `appointmentBooking`,
    /// `stopBot`, `humanHandOver`, `advancedFollowup`, `transferBot`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
    /// Agent ID where the action belongs
    #[serde(rename = "agentId", default, skip_serializing_if = "Option::is_none")]
    pub agent_id: Option<String>,
    /// Action-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW
    /// use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for
    /// APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for
    /// HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and
    /// for TRANSFER_BOT use transferBotDto.
    /// Multiple possible shapes in the spec; raw JSON.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub details: Option<serde_json::Value>,
}

/// `ActionsIdDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ActionsIdDto {
    /// Unique identifier for the action.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// type of action.
    /// Allowed values: `triggerWorkflow`, `updateContactField`, `appointmentBooking`,
    /// `stopBot`, `humanHandOver`, `advancedFollowup`, `transferBot`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
}

/// `CreateActionDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateActionDTO {
    /// Allowed values: `triggerWorkflow`, `updateContactField`, `appointmentBooking`,
    /// `stopBot`, `humanHandOver`, `advancedFollowup`, `transferBot`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Required by the API.
    pub name: String,
    /// Action-specific details. The structure depends on the action type. For TRIGGER_WORKFLOW
    /// use triggerWorkflowDto, for UPDATE_CONTACT_FIELD use updateContactFieldDto, for
    /// APPOINTMENT_BOOKING use appointmentBookingDto, for STOP_BOT use stopBotDto, for
    /// HUMAN_HAND_OVER use humanHandOverDto, for ADVANCED_FOLLOWUP use advancedFollowupDto, and
    /// for TRANSFER_BOT use transferBotDto.
    /// Multiple possible shapes in the spec; raw JSON.
    /// Required by the API.
    pub details: serde_json::Value,
}

/// `CreateEmployeeDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateEmployeeDto {
    /// Name of the agent.
    /// Required by the API.
    pub name: String,
    /// Name of the business the agent represents.
    #[serde(
        rename = "businessName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_name: Option<String>,
    /// Mode of operation - OFF, SUGGESTIVE, or AUTO_PILOT
    /// Allowed values: `off`, `suggestive`, `auto-pilot`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mode: Option<String>,
    /// Communication channels the agent can operate on
    /// Allowed values: `IG`, `FB`, `SMS`, `WebChat`, `WhatsApp`, `Live_Chat`.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub channels: Vec<String>,
    /// Indicates if this agent is a primary agent.
    #[serde(rename = "isPrimary", default, skip_serializing_if = "Option::is_none")]
    pub is_primary: Option<bool>,
    /// Wait time before agent responds (max 5 for minutes, 300 for seconds)
    #[serde(rename = "waitTime", default, skip_serializing_if = "Option::is_none")]
    pub wait_time: Option<f64>,
    /// Unit for wait time - SECONDS or MINUTES
    /// Allowed values: `minutes`, `seconds`.
    #[serde(
        rename = "waitTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub wait_time_unit: Option<String>,
    /// Indicates if sleep functionality is enabled.
    #[serde(
        rename = "sleepEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_enabled: Option<bool>,
    /// Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite
    /// sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set
    /// to null for indefinite sleep.
    /// Allowed values: `hours`, `minutes`, `seconds`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// Personality traits of the agent.
    /// Required by the API.
    pub personality: String,
    /// The goal of the agent.
    /// Required by the API.
    pub goal: String,
    /// Instructions for the agent.
    /// Required by the API.
    pub instructions: String,
    /// Maximum number of messages in auto-pilot mode before requiring human intervention. (max:
    /// 100, min: 1)
    #[serde(
        rename = "autoPilotMaxMessages",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub auto_pilot_max_messages: Option<f64>,
    /// Array of knowledge base IDs associated with this agent.
    #[serde(
        rename = "knowledgeBaseIds",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub knowledge_base_ids: Vec<String>,
    /// Allow agent to respond to images
    #[serde(
        rename = "respondToImages",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub respond_to_images: Option<bool>,
    /// Allow agent to respond to audio
    #[serde(
        rename = "respondToAudio",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub respond_to_audio: Option<bool>,
    /// Enable sleep when a manual outbound message is sent.
    #[serde(
        rename = "sleepOnManualMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_manual_message: Option<bool>,
    /// Enable sleep when a workflow outbound message is sent.
    #[serde(
        rename = "sleepOnWorkflowMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_workflow_message: Option<bool>,
}

/// `DeleteActionDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteActionDataDTO {
    /// ID of the deleted action
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
}

/// `DeleteEmployeeResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteEmployeeResponseDTO {
    /// Indicates if the agent was deleted successfully.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// Unique identifier of the deleted agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
}

/// `EmployeeListItemDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct EmployeeListItemDTO {
    /// Unique identifier for the agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Name of the agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Name of the business the agent represents.
    #[serde(
        rename = "businessName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_name: Option<String>,
    /// Current operating mode of the agent.
    /// Allowed values: `off`, `suggestive`, `auto-pilot`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mode: Option<String>,
    /// Communication channels the agent operates on.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub channels: Vec<String>,
    /// Wait time before agent responds.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "waitTime", default, skip_serializing_if = "Option::is_none")]
    pub wait_time: Option<f64>,
    /// Unit for wait time.
    /// Allowed values: `minutes`, `seconds`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "waitTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub wait_time_unit: Option<String>,
    /// Indicates if sleep functionality is enabled.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "sleepEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_enabled: Option<bool>,
    /// Duration of sleep period.
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Unit of sleep time.
    /// Allowed values: `hours`, `minutes`, `seconds`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// List of actions associated with this agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub actions: Vec<serde_json::Value>,
    /// Indicates if this agent is a primary agent. (First agent created for a location is
    /// primary by default)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "isPrimary", default, skip_serializing_if = "Option::is_none")]
    pub is_primary: Option<bool>,
    /// Maximum number of messages in auto-pilot mode before requiring human intervention.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "autoPilotMaxMessages",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub auto_pilot_max_messages: Option<f64>,
    /// Goal configuration for the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub goal: Option<serde_json::Value>,
    /// Array of knowledge base IDs associated with this agent.
    #[serde(
        rename = "knowledgeBaseIds",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub knowledge_base_ids: Vec<String>,
    /// Timestamp when the agent was created.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "createdAt", default, skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// Timestamp when the agent was last updated.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "updatedAt", default, skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    /// Whether the bot sleeps on manual outbound messages.
    #[serde(
        rename = "sleepOnManualMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_manual_message: Option<bool>,
    /// Whether the bot sleeps on workflow outbound messages.
    #[serde(
        rename = "sleepOnWorkflowMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_workflow_message: Option<bool>,
}

/// `EmployeeResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct EmployeeResponseDTO {
    /// Unique identifier for the agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Name of the agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Name of the business the agent represents.
    #[serde(
        rename = "businessName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_name: Option<String>,
    /// Current operating mode of the agent.
    /// Allowed values: `off`, `suggestive`, `auto-pilot`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mode: Option<String>,
    /// Communication channels the agent operates on.
    /// Allowed values: `IG`, `FB`, `SMS`, `WebChat`, `WhatsApp`, `Live_Chat`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub channels: Vec<String>,
    /// Wait time before agent responds.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "waitTime", default, skip_serializing_if = "Option::is_none")]
    pub wait_time: Option<f64>,
    /// Unit for wait time.
    /// Allowed values: `minutes`, `seconds`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "waitTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub wait_time_unit: Option<String>,
    /// Indicates if sleep functionality is enabled.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "sleepEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_enabled: Option<bool>,
    /// Duration of sleep period.
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Unit of sleep time.
    /// Allowed values: `hours`, `minutes`, `seconds`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// List of actions associated with this agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub actions: Vec<ActionsIdDto>,
    /// Indicates if this agent is a primary agent.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "isPrimary", default, skip_serializing_if = "Option::is_none")]
    pub is_primary: Option<bool>,
    /// Maximum number of messages in auto-pilot mode before requiring human intervention.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "autoPilotMaxMessages",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub auto_pilot_max_messages: Option<f64>,
    /// The goal of the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub goal: Option<String>,
    /// Personality traits of the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub personality: Option<String>,
    /// Instructions for the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instructions: Option<String>,
    /// Array of knowledge base IDs associated with this agent.
    #[serde(
        rename = "knowledgeBaseIds",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub knowledge_base_ids: Vec<String>,
    /// Whether the bot sleeps on manual outbound messages.
    #[serde(
        rename = "sleepOnManualMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_manual_message: Option<bool>,
    /// Whether the bot sleeps on workflow outbound messages.
    #[serde(
        rename = "sleepOnWorkflowMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_workflow_message: Option<bool>,
}

/// `FetchAIResponseDetailsResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FetchAIResponseDetailsResponseDTO {
    /// The complete prompt used for the AI response.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub prompt: Option<String>,
    /// The intent/goal extracted from location prompt.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub intent: Option<String>,
    /// The response message generated by the AI.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "responseMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub response_message: Option<String>,
    /// FAQ chunks used in generating the response from fine-tuned data.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub faqs: Vec<serde_json::Value>,
    /// Website content chunks used in generating the response.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub website: Vec<serde_json::Value>,
    /// ID of the employee/agent that generated the response.
    #[serde(rename = "agentId", default, skip_serializing_if = "Option::is_none")]
    pub agent_id: Option<String>,
    /// The original input message that triggered this response.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub input: Option<String>,
    /// List of actions taken during this interaction.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "actionLogs", default, skip_serializing_if = "Vec::is_empty")]
    pub action_logs: Vec<serde_json::Value>,
    /// Conversation history leading up to this response.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub history: Vec<serde_json::Value>,
    /// Mode of operation during this interaction.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mode: Option<String>,
}

/// `FollowupSequence` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FollowupSequence {
    /// Unique identifier for this followup step
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<f64>,
    /// Time unit for followup delay
    /// Allowed values: `days`, `hours`, `minutes`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "followupTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub followup_time_unit: Option<String>,
    /// Time duration before followup (max: 60 minutes, 24 hours, or 180 days depending on unit)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "followupTime",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub followup_time: Option<f64>,
    /// Whether to use AI to generate the followup message
    #[serde(
        rename = "aiEnabledMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub ai_enabled_message: Option<bool>,
    /// Whether to trigger a workflow during this followup
    #[serde(
        rename = "triggerWorkflow",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub trigger_workflow: Option<bool>,
    /// Custom message to send (when aiEnabledMessage is false)
    #[serde(
        rename = "customMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub custom_message: Option<String>,
    /// Workflow ID to trigger (when triggerWorkflow is true)
    #[serde(
        rename = "workflowId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub workflow_id: Option<String>,
    /// Whether contact was requested in this followup
    #[serde(
        rename = "contactRequested",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_requested: Option<bool>,
}

/// `FollowupSettings` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FollowupSettings {
    /// Whether to dynamically switch channels for followups
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "dynamicChannelSwitching",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub dynamic_channel_switching: Option<bool>,
    /// Whether to respect working hours for followups
    #[serde(
        rename = "followUpHours",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub follow_up_hours: Option<bool>,
    /// Working hours configuration for followups
    #[serde(
        rename = "workingHours",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub working_hours: Vec<WorkingHours>,
    /// Timezone to use for followups, contact or location
    /// Allowed values: `contact`, `business`.
    #[serde(
        rename = "timezoneToUse",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub timezone_to_use: Option<String>,
}

/// `Interval` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Interval {
    /// Start hour (24-hour format)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "startHour", default, skip_serializing_if = "Option::is_none")]
    pub start_hour: Option<f64>,
    /// Start minute
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "startMinute",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub start_minute: Option<f64>,
    /// End hour (24-hour format)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "endHour", default, skip_serializing_if = "Option::is_none")]
    pub end_hour: Option<f64>,
    /// End minute
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "endMinute", default, skip_serializing_if = "Option::is_none")]
    pub end_minute: Option<f64>,
}

/// `SearchEmployeeResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SearchEmployeeResponseDTO {
    /// List of agents matching the search criteria.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub agents: Vec<EmployeeListItemDTO>,
    /// Total number of agents in the location (unfiltered count).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "totalCount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub total_count: Option<f64>,
    /// Number of agents in the current response (filtered/paginated count).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub count: Option<f64>,
}

/// `UpdateEmployeeDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateEmployeeDto {
    /// Name of the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Name of the business the agent represents.
    #[serde(
        rename = "businessName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_name: Option<String>,
    /// Mode of operation for the agent, required if primary is enabled.
    /// Allowed values: `off`, `suggestive`, `auto-pilot`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mode: Option<String>,
    /// Channels the agent can use.
    /// Allowed values: `IG`, `FB`, `SMS`, `WebChat`, `WhatsApp`, `Live_Chat`.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub channels: Vec<String>,
    /// Indicates if this agent is a primary agent.
    #[serde(rename = "isPrimary", default, skip_serializing_if = "Option::is_none")]
    pub is_primary: Option<bool>,
    /// Wait time before agent responds (max 5 for minutes, 300 for seconds).
    #[serde(rename = "waitTime", default, skip_serializing_if = "Option::is_none")]
    pub wait_time: Option<f64>,
    /// Unit for wait time - SECONDS or MINUTES
    /// Allowed values: `minutes`, `seconds`.
    #[serde(
        rename = "waitTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub wait_time_unit: Option<String>,
    /// Indicates if sleep functionality is enabled.
    #[serde(
        rename = "sleepEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_enabled: Option<bool>,
    /// Duration of sleep period (required if sleepEnabled is true). Set to null for indefinite
    /// sleep. (max 2880 for minutes, 172800 for seconds, 48 for hours)
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Unit of sleep time - HOURS, MINUTES, or SECONDS (required if sleepEnabled is true). Set
    /// to null for indefinite sleep.
    /// Allowed values: `hours`, `minutes`, `seconds`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// Personality traits of the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub personality: Option<String>,
    /// The goal of the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub goal: Option<String>,
    /// Instructions for the agent.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instructions: Option<String>,
    /// Maximum number of messages in auto-pilot mode before requiring human intervention. (max:
    /// 100, min: 1)
    /// Required by the API.
    #[serde(rename = "autoPilotMaxMessages")]
    pub auto_pilot_max_messages: f64,
    /// Array of knowledge base IDs associated with this agent.
    #[serde(
        rename = "knowledgeBaseIds",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub knowledge_base_ids: Vec<String>,
    /// Allow agent to respond to images
    #[serde(
        rename = "respondToImages",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub respond_to_images: Option<bool>,
    /// Allow agent to respond to audio
    #[serde(
        rename = "respondToAudio",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub respond_to_audio: Option<bool>,
    /// Enable sleep when a manual outbound message is sent.
    #[serde(
        rename = "sleepOnManualMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_manual_message: Option<bool>,
    /// Enable sleep when a workflow outbound message is sent.
    #[serde(
        rename = "sleepOnWorkflowMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_on_workflow_message: Option<bool>,
}

/// `UpdateFollowupSettingsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateFollowupSettingsDTO {
    /// Required by the API.
    #[serde(rename = "actionIds", default, skip_serializing_if = "Vec::is_empty")]
    pub action_ids: Vec<String>,
    /// Required by the API.
    #[serde(rename = "followupSettings")]
    pub followup_settings: FollowupSettings,
}

/// `WorkingHours` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct WorkingHours {
    /// Day of the week (0=Sunday, 1=Monday, etc.)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "dayOfTheWeek",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub day_of_the_week: Option<f64>,
    /// Time intervals for this day
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub intervals: Vec<Interval>,
}

/// `advancedFollowupDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AdvancedFollowupDto {
    /// Whether advanced followup is enabled
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// ID of the followup scenario
    /// Allowed values: `contactStoppedReplying`, `contactIsBusy`, `contactRequested`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "scenarioId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub scenario_id: Option<String>,
    /// Sequence of followup actions to perform
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "followupSequence",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub followup_sequence: Vec<FollowupSequence>,
    /// Additional settings for followup behavior
    #[serde(
        rename = "followupSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub followup_settings: Option<FollowupSettings>,
}

/// `appointmentBookingDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AppointmentBookingDto {
    /// Optional action ID reference
    #[serde(rename = "actionId", default, skip_serializing_if = "Option::is_none")]
    pub action_id: Option<String>,
    /// Calendar ID for appointment booking
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "calendarId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub calendar_id: Option<String>,
    /// If true, only sends the appointment link without booking
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "onlySendLink",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub only_send_link: Option<bool>,
    /// Whether to trigger a workflow after booking (cannot be true when onlySendLink is true)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "triggerWorkflow",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub trigger_workflow: Option<bool>,
    /// Workflow IDs to trigger after booking (required when triggerWorkflow is true)
    #[serde(rename = "workflowIds", default, skip_serializing_if = "Vec::is_empty")]
    pub workflow_ids: Vec<String>,
    /// Whether to put the agent to sleep after booking (cannot be true when onlySendLink is
    /// true)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "sleepAfterBooking",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_after_booking: Option<bool>,
    /// Unit for sleep time (required when sleepAfterBooking is true)
    /// Allowed values: `days`, `hours`, `minutes`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// Sleep duration (required when sleepAfterBooking is true)
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Whether to transfer to another agent after booking (cannot be true when onlySendLink is
    /// true)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "transferBot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub transfer_bot: Option<bool>,
    /// Agent ID to transfer to (required when transferBot is true)
    #[serde(
        rename = "transferAgent",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub transfer_agent: Option<String>,
    /// Whether to allow appointment rescheduling (cannot be true when onlySendLink is true)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "rescheduleEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub reschedule_enabled: Option<bool>,
    /// Whether to allow appointment cancellation (cannot be true when onlySendLink is true)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "cancelEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub cancel_enabled: Option<bool>,
}

/// `createActionResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateActionResponseDTO {
    /// Created action details
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data: Option<ActionDataDTO>,
    /// Success status of the request
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `deleteActionResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteActionResponseDTO {
    /// Deleted action information
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data: Option<DeleteActionDataDTO>,
    /// Success status of the request
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `fetchActionDetailsResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FetchActionDetailsResponseDTO {
    /// Action details
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data: Option<ActionDataDTO>,
    /// Success status of the request
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `fetchActionsForEmployeeResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FetchActionsForEmployeeResponseDTO {
    /// Grouped actions by type
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<ActionDataDTO>,
    /// Success status of the request
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `humanHandOverDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct HumanHandOverDto {
    /// Whether human handover action is enabled
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Condition that triggers human handover
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "triggerCondition",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub trigger_condition: Option<String>,
    /// Example phrases that trigger human handover (required when handoverType is custom or
    /// contactRequest)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub examples: Vec<String>,
    /// ID of the user to assign the conversation to
    #[serde(
        rename = "assignToUserId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assign_to_user_id: Option<String>,
    /// Whether to skip assigning to a specific user
    #[serde(
        rename = "skipAssignToUser",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub skip_assign_to_user: Option<bool>,
    /// Whether to create a task when handing over
    #[serde(
        rename = "createTask",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub create_task: Option<bool>,
    /// Whether the agent can be reactivated after handover
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "reactivateEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub reactivate_enabled: Option<bool>,
    /// Time unit for reactivation delay (required when reactivateEnabled is true)
    /// Allowed values: `days`, `hours`, `minutes`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// Time duration before reactivation (required when reactivateEnabled is true)
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Final message sent when handing over to human
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "finalMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub final_message: Option<String>,
    /// Tags to apply during handover
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
    /// Type of human handover detection
    /// Allowed values: `contactRequest`, `lackOfInformation`, `failedToResolveIssue`, `custom`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "handoverType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub handover_type: Option<String>,
}

/// `stopBotDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StopBotDto {
    /// Type of stop bot detection - Goodbye or Custom
    /// Allowed values: `Goodbye`, `Custom`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "stopBotDetectionType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub stop_bot_detection_type: Option<String>,
    /// Condition that triggers stopping the bot
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "stopBotTriggerCondition",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub stop_bot_trigger_condition: Option<String>,
    /// Whether the bot can be reactivated after being stopped
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "reactivateEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub reactivate_enabled: Option<bool>,
    /// Time unit for reactivation delay (required when reactivateEnabled is true)
    /// Allowed values: `days`, `hours`, `minutes`.
    #[serde(
        rename = "sleepTimeUnit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub sleep_time_unit: Option<String>,
    /// Time duration before reactivation (required when reactivateEnabled is true)
    #[serde(rename = "sleepTime", default, skip_serializing_if = "Option::is_none")]
    pub sleep_time: Option<f64>,
    /// Whether this action is enabled for the agent
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Example phrases that trigger stop bot action (minimum 2 required)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "stopBotExamples",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub stop_bot_examples: Vec<String>,
    /// Final message sent when stopping the bot
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "finalMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub final_message: Option<String>,
    /// Tags to apply when stopping the bot
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<String>,
}

/// `transferBotDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TransferBotDto {
    /// Type of transfer - Default or Custom
    /// Allowed values: `Default`, `Custom`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "transferBotType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub transfer_bot_type: Option<String>,
    /// ID of the bot/agent to transfer to
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "transferToBot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub transfer_to_bot: Option<String>,
    /// Whether this transfer action is enabled
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Condition that triggers the transfer (required for Custom type)
    #[serde(
        rename = "transferBotTriggerCondition",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub transfer_bot_trigger_condition: Option<String>,
    /// Example phrases that trigger transfer (required for Custom type, minimum 2)
    #[serde(
        rename = "transferBotExamples",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub transfer_bot_examples: Vec<String>,
}

/// `triggerWorkflowDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TriggerWorkflowDto {
    /// Array of workflow IDs to trigger
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "workflowIds", default, skip_serializing_if = "Vec::is_empty")]
    pub workflow_ids: Vec<String>,
    /// Condition that triggers the workflow
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "triggerCondition",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub trigger_condition: Option<String>,
    /// Optional message to send when triggering the workflow
    #[serde(
        rename = "triggerMessage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub trigger_message: Option<String>,
}

/// `updateActionResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateActionResponseDTO {
    /// Updated action details
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data: Option<ActionDataDTO>,
    /// Success status of the request
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `updateContactFieldDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateContactFieldDto {
    /// ID of the contact field in Contacts Table
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "contactFieldId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_field_id: Option<String>,
    /// Description of the contact field in Contacts Table
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Contact update examples in Contacts Table. Not required when using standard fields,
    /// Monetory or Date Custom fields.
    #[serde(
        rename = "contactUpdateExamples",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub contact_update_examples: Vec<String>,
}