backbone-mail 0.2.32

Odoo mail core port — message/notification/followers/activity/alias/sms queue (schema: messaging)
//! MailScheduledMessage DTOs (Data Transfer Objects)
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! DTOs provide a clean separation between domain entities and API
//! representations, with validation and OpenAPI documentation support.

use serde::{Deserialize, Serialize};
use uuid::Uuid;
use chrono::{DateTime, Utc};

#[cfg(feature = "openapi")]
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

#[cfg(feature = "validation")]
use validator::Validate;

use crate::domain::entity::MailScheduledMessage;
use crate::domain::entity::AuditMetadata;

// =============================================================================
// Create DTO
// =============================================================================

/// Request DTO for creating a new MailScheduledMessage
///
/// Used in POST requests to create new entities.
/// Excludes auto-generated fields (id, created_at, updated_at, deleted_at).
#[derive(Debug, Clone, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct CreateMailScheduledMessageDto {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub body: String,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    #[serde(alias = "scheduled_date")]
    pub scheduled_date: DateTime<Utc>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "composition_comment_option")]
    pub composition_comment_option: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub model: String,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "res_id")]
    pub res_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "author_party_id")]
    pub author_party_id: Uuid,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "recipient_party_ids")]
    pub recipient_party_ids: Option<serde_json::Value>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "is_note")]
    pub is_note: bool,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "notification_parameters")]
    pub notification_parameters: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "send_context")]
    pub send_context: Option<serde_json::Value>,
}

// =============================================================================
// Update DTO
// =============================================================================

/// Request DTO for full update of a MailScheduledMessage
///
/// Used in PUT requests for full entity replacement.
/// All fields are required (except auto-generated ones).
#[derive(Debug, Clone, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct UpdateMailScheduledMessageDto {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub body: String,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    #[serde(alias = "scheduled_date")]
    pub scheduled_date: DateTime<Utc>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "composition_comment_option")]
    pub composition_comment_option: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub model: String,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "res_id")]
    pub res_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "author_party_id")]
    pub author_party_id: Uuid,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "recipient_party_ids")]
    pub recipient_party_ids: Option<serde_json::Value>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "is_note")]
    pub is_note: bool,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "notification_parameters")]
    pub notification_parameters: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "send_context")]
    pub send_context: Option<serde_json::Value>,
}

// =============================================================================
// Patch DTO
// =============================================================================

/// Request DTO for partial update of a MailScheduledMessage
///
/// Used in PATCH requests for partial updates.
/// All fields are optional - only provided fields will be updated.
#[derive(Debug, Clone, Default, Deserialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[cfg_attr(feature = "validation", derive(Validate))]
#[serde(rename_all = "camelCase")]
pub struct PatchMailScheduledMessageDto {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "scheduled_date")]
    pub scheduled_date: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "composition_comment_option")]
    pub composition_comment_option: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "res_id")]
    pub res_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "author_party_id")]
    pub author_party_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "recipient_party_ids")]
    pub recipient_party_ids: Option<serde_json::Value>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "is_note")]
    pub is_note: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "notification_parameters")]
    pub notification_parameters: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "send_context")]
    pub send_context: Option<serde_json::Value>,
}

impl PatchMailScheduledMessageDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.subject.is_some() || self.body.is_some() || self.scheduled_date.is_some() || self.composition_comment_option.is_some() || self.model.is_some() || self.res_id.is_some() || self.author_party_id.is_some() || self.recipient_party_ids.is_some() || self.is_note.is_some() || self.notification_parameters.is_some() || self.send_context.is_some()
    }
}

// =============================================================================
// Response DTO
// =============================================================================

/// Response DTO for MailScheduledMessage entity
///
/// Used in API responses for single entity.
/// Includes all fields including metadata.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct MailScheduledMessageResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    pub subject: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub body: String,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    pub scheduled_date: DateTime<Utc>,
    pub composition_comment_option: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub model: String,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub res_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub author_party_id: Uuid,
    pub recipient_party_ids: Option<serde_json::Value>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub is_note: bool,
    pub notification_parameters: Option<String>,
    pub send_context: Option<serde_json::Value>,
    pub metadata: AuditMetadata,
}

// =============================================================================
// List Response DTO
// =============================================================================

/// Paginated list response for MailScheduledMessage entities
///
/// Used in API responses for list endpoints.
/// Includes pagination metadata.
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct MailScheduledMessageListResponseDto {
    /// List of items
    pub items: Vec<MailScheduledMessageResponseDto>,
    /// Total number of items (across all pages)
    pub total: u64,
    /// Current page number (1-indexed)
    pub page: u32,
    /// Number of items per page
    pub per_page: u32,
    /// Total number of pages
    pub total_pages: u32,
    /// Whether there is a next page
    pub has_next: bool,
    /// Whether there is a previous page
    pub has_prev: bool,
}

impl MailScheduledMessageListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<MailScheduledMessageResponseDto>, total: u64, page: u32, per_page: u32) -> Self {
        let total_pages = if per_page > 0 {
            ((total as f64) / (per_page as f64)).ceil() as u32
        } else {
            0
        };
        Self {
            items,
            total,
            page,
            per_page,
            total_pages,
            has_next: page < total_pages,
            has_prev: page > 1,
        }
    }
}

/// Summary DTO for list views (compact version)
#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct MailScheduledMessageSummaryDto {
    pub id: Uuid,
    pub subject: Option<String>,
    pub body: String,
    pub scheduled_date: DateTime<Utc>,
    pub created_at: Option<DateTime<Utc>>,
}

// =============================================================================
// Conversions
// =============================================================================

impl From<MailScheduledMessage> for MailScheduledMessageResponseDto {
    fn from(entity: MailScheduledMessage) -> Self {
        Self {
            id: entity.id,
            subject: entity.subject,
            body: entity.body,
            scheduled_date: entity.scheduled_date,
            composition_comment_option: entity.composition_comment_option,
            model: entity.model,
            res_id: entity.res_id,
            author_party_id: entity.author_party_id,
            recipient_party_ids: entity.recipient_party_ids,
            is_note: entity.is_note,
            notification_parameters: entity.notification_parameters,
            send_context: entity.send_context,
            metadata: entity.metadata,
        }
    }
}

impl From<MailScheduledMessage> for MailScheduledMessageSummaryDto {
    fn from(entity: MailScheduledMessage) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            subject: entity.subject,
            body: entity.body,
            scheduled_date: entity.scheduled_date,
            created_at,
        }
    }
}

impl From<CreateMailScheduledMessageDto> for MailScheduledMessage {
    fn from(dto: CreateMailScheduledMessageDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            subject: dto.subject,
            body: dto.body,
            scheduled_date: dto.scheduled_date,
            composition_comment_option: dto.composition_comment_option,
            model: dto.model,
            res_id: dto.res_id,
            author_party_id: dto.author_party_id,
            recipient_party_ids: dto.recipient_party_ids,
            is_note: dto.is_note,
            notification_parameters: dto.notification_parameters,
            send_context: dto.send_context,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&MailScheduledMessage> for MailScheduledMessageResponseDto {
    fn from(entity: &MailScheduledMessage) -> Self {
        Self {
            id: entity.id.clone(),
            subject: entity.subject.clone(),
            body: entity.body.clone(),
            scheduled_date: entity.scheduled_date.clone(),
            composition_comment_option: entity.composition_comment_option.clone(),
            model: entity.model.clone(),
            res_id: entity.res_id.clone(),
            author_party_id: entity.author_party_id.clone(),
            recipient_party_ids: entity.recipient_party_ids.clone(),
            is_note: entity.is_note.clone(),
            notification_parameters: entity.notification_parameters.clone(),
            send_context: entity.send_context.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

impl backbone_core::FromCreateDto<CreateMailScheduledMessageDto> for MailScheduledMessage {
    fn from_create_dto(dto: CreateMailScheduledMessageDto) -> backbone_core::ServiceResult<Self> {
        Ok(MailScheduledMessage::from(dto))
    }
}

impl backbone_core::ApplyUpdateDto<UpdateMailScheduledMessageDto> for MailScheduledMessage {
    fn apply_update(mut self, dto: UpdateMailScheduledMessageDto) -> backbone_core::ServiceResult<Self> {
        self.subject = dto.subject;
        self.body = dto.body;
        self.scheduled_date = dto.scheduled_date;
        self.composition_comment_option = dto.composition_comment_option;
        self.model = dto.model;
        self.res_id = dto.res_id;
        self.author_party_id = dto.author_party_id;
        self.recipient_party_ids = dto.recipient_party_ids;
        self.is_note = dto.is_note;
        self.notification_parameters = dto.notification_parameters;
        self.send_context = dto.send_context;
        Ok(self)
    }
}

// =============================================================================
// Custom DTOs
// =============================================================================

// <<< CUSTOM DTOs
// Add custom DTOs specific to MailScheduledMessage here.
// This section will be preserved during regeneration.
// >>> END CUSTOM DTOs