backbone-mail 0.2.32

//! Mail 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::Mail;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::MailFailureType;
use crate::domain::entity::MailState;

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

/// Request DTO for creating a new Mail
///
/// 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 CreateMailDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "mail_message_id")]
    pub mail_message_id: Uuid,
    pub state: MailState,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_type")]
    pub failure_type: Option<MailFailureType>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "scheduled_date")]
    pub scheduled_date: Option<DateTime<Utc>>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "auto_delete")]
    pub auto_delete: bool,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_reason")]
    pub failure_reason: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "email_to")]
    pub email_to: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "email_cc")]
    pub email_cc: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "reply_to")]
    pub reply_to: Option<String>,
    pub headers: serde_json::Value,
}

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

/// Request DTO for full update of a Mail
///
/// 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 UpdateMailDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "mail_message_id")]
    pub mail_message_id: Uuid,
    pub state: MailState,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_type")]
    pub failure_type: Option<MailFailureType>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "scheduled_date")]
    pub scheduled_date: Option<DateTime<Utc>>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "auto_delete")]
    pub auto_delete: bool,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_reason")]
    pub failure_reason: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "email_to")]
    pub email_to: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "email_cc")]
    pub email_cc: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "reply_to")]
    pub reply_to: Option<String>,
    pub headers: serde_json::Value,
}

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

/// Request DTO for partial update of a Mail
///
/// 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 PatchMailDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "mail_message_id")]
    pub mail_message_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<MailState>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "failure_type")]
    pub failure_type: Option<MailFailureType>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "scheduled_date")]
    pub scheduled_date: Option<DateTime<Utc>>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "auto_delete")]
    pub auto_delete: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "failure_reason")]
    pub failure_reason: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "email_to")]
    pub email_to: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "email_cc")]
    pub email_cc: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "reply_to")]
    pub reply_to: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub headers: Option<serde_json::Value>,
}

impl PatchMailDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.mail_message_id.is_some() || self.state.is_some() || self.failure_type.is_some() || self.scheduled_date.is_some() || self.auto_delete.is_some() || self.failure_reason.is_some() || self.email_to.is_some() || self.email_cc.is_some() || self.reply_to.is_some() || self.headers.is_some()
    }
}

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

/// Response DTO for Mail 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 MailResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub mail_message_id: Uuid,
    pub state: MailState,
    pub failure_type: Option<MailFailureType>,
    pub scheduled_date: Option<DateTime<Utc>>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub auto_delete: bool,
    pub failure_reason: Option<String>,
    pub email_to: Option<String>,
    pub email_cc: Option<String>,
    pub reply_to: Option<String>,
    pub headers: serde_json::Value,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for Mail 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 MailListResponseDto {
    /// List of items
    pub items: Vec<MailResponseDto>,
    /// 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 MailListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<MailResponseDto>, 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 MailSummaryDto {
    pub id: Uuid,
    pub mail_message_id: Uuid,
    pub state: MailState,
    pub failure_type: Option<MailFailureType>,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<Mail> for MailResponseDto {
    fn from(entity: Mail) -> Self {
        Self {
            id: entity.id,
            mail_message_id: entity.mail_message_id,
            state: entity.state,
            failure_type: entity.failure_type,
            scheduled_date: entity.scheduled_date,
            auto_delete: entity.auto_delete,
            failure_reason: entity.failure_reason,
            email_to: entity.email_to,
            email_cc: entity.email_cc,
            reply_to: entity.reply_to,
            headers: entity.headers,
            metadata: entity.metadata,
        }
    }
}

impl From<Mail> for MailSummaryDto {
    fn from(entity: Mail) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            mail_message_id: entity.mail_message_id,
            state: entity.state,
            failure_type: entity.failure_type,
            created_at,
        }
    }
}

impl From<CreateMailDto> for Mail {
    fn from(dto: CreateMailDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            mail_message_id: dto.mail_message_id,
            state: dto.state,
            failure_type: dto.failure_type,
            scheduled_date: dto.scheduled_date,
            auto_delete: dto.auto_delete,
            failure_reason: dto.failure_reason,
            email_to: dto.email_to,
            email_cc: dto.email_cc,
            reply_to: dto.reply_to,
            headers: dto.headers,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&Mail> for MailResponseDto {
    fn from(entity: &Mail) -> Self {
        Self {
            id: entity.id.clone(),
            mail_message_id: entity.mail_message_id.clone(),
            state: entity.state.clone(),
            failure_type: entity.failure_type.clone(),
            scheduled_date: entity.scheduled_date.clone(),
            auto_delete: entity.auto_delete.clone(),
            failure_reason: entity.failure_reason.clone(),
            email_to: entity.email_to.clone(),
            email_cc: entity.email_cc.clone(),
            reply_to: entity.reply_to.clone(),
            headers: entity.headers.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdateMailDto> for Mail {
    fn apply_update(mut self, dto: UpdateMailDto) -> backbone_core::ServiceResult<Self> {
        self.mail_message_id = dto.mail_message_id;
        self.state = dto.state;
        self.failure_type = dto.failure_type;
        self.scheduled_date = dto.scheduled_date;
        self.auto_delete = dto.auto_delete;
        self.failure_reason = dto.failure_reason;
        self.email_to = dto.email_to;
        self.email_cc = dto.email_cc;
        self.reply_to = dto.reply_to;
        self.headers = dto.headers;
        Ok(self)
    }
}

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

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