backbone-mail 0.2.32

Odoo mail core port — message/notification/followers/activity/alias/sms queue (schema: messaging)
//! MailServer 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::MailServer;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::SmtpAuthentication;
use crate::domain::entity::SmtpEncryption;

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

/// Request DTO for creating a new MailServer
///
/// 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 CreateMailServerDto {
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "from_filter")]
    pub from_filter: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(alias = "smtp_host")]
    pub smtp_host: String,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(alias = "smtp_port")]
    pub smtp_port: i32,
    #[serde(alias = "smtp_authentication")]
    pub smtp_authentication: SmtpAuthentication,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "smtp_user")]
    pub smtp_user: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "smtp_pass_ref")]
    pub smtp_pass_ref: Option<String>,
    #[serde(alias = "smtp_encryption")]
    pub smtp_encryption: SmtpEncryption,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "smtp_debug")]
    pub smtp_debug: bool,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub sequence: i32,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub active: bool,
}

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

/// Request DTO for full update of a MailServer
///
/// 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 UpdateMailServerDto {
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "from_filter")]
    pub from_filter: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(alias = "smtp_host")]
    pub smtp_host: String,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(alias = "smtp_port")]
    pub smtp_port: i32,
    #[serde(alias = "smtp_authentication")]
    pub smtp_authentication: SmtpAuthentication,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "smtp_user")]
    pub smtp_user: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "smtp_pass_ref")]
    pub smtp_pass_ref: Option<String>,
    #[serde(alias = "smtp_encryption")]
    pub smtp_encryption: SmtpEncryption,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "smtp_debug")]
    pub smtp_debug: bool,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub sequence: i32,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub active: bool,
}

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

/// Request DTO for partial update of a MailServer
///
/// 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 PatchMailServerDto {
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "from_filter")]
    pub from_filter: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_host")]
    pub smtp_host: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_port")]
    pub smtp_port: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_authentication")]
    pub smtp_authentication: Option<SmtpAuthentication>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_user")]
    pub smtp_user: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_pass_ref")]
    pub smtp_pass_ref: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_encryption")]
    pub smtp_encryption: Option<SmtpEncryption>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "smtp_debug")]
    pub smtp_debug: Option<bool>,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sequence: Option<i32>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active: Option<bool>,
}

impl PatchMailServerDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.name.is_some() || self.from_filter.is_some() || self.smtp_host.is_some() || self.smtp_port.is_some() || self.smtp_authentication.is_some() || self.smtp_user.is_some() || self.smtp_pass_ref.is_some() || self.smtp_encryption.is_some() || self.smtp_debug.is_some() || self.sequence.is_some() || self.active.is_some()
    }
}

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

/// Response DTO for MailServer 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 MailServerResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub name: String,
    pub from_filter: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub smtp_host: String,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub smtp_port: i32,
    pub smtp_authentication: SmtpAuthentication,
    pub smtp_user: Option<String>,
    pub smtp_pass_ref: Option<String>,
    pub smtp_encryption: SmtpEncryption,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub smtp_debug: bool,
    #[cfg_attr(feature = "openapi", schema(example = 42))]
    pub sequence: i32,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub active: bool,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for MailServer 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 MailServerListResponseDto {
    /// List of items
    pub items: Vec<MailServerResponseDto>,
    /// 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 MailServerListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<MailServerResponseDto>, 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 MailServerSummaryDto {
    pub id: Uuid,
    pub name: String,
    pub from_filter: Option<String>,
    pub smtp_host: String,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<MailServer> for MailServerResponseDto {
    fn from(entity: MailServer) -> Self {
        Self {
            id: entity.id,
            name: entity.name,
            from_filter: entity.from_filter,
            smtp_host: entity.smtp_host,
            smtp_port: entity.smtp_port,
            smtp_authentication: entity.smtp_authentication,
            smtp_user: entity.smtp_user,
            smtp_pass_ref: entity.smtp_pass_ref,
            smtp_encryption: entity.smtp_encryption,
            smtp_debug: entity.smtp_debug,
            sequence: entity.sequence,
            active: entity.active,
            metadata: entity.metadata,
        }
    }
}

impl From<MailServer> for MailServerSummaryDto {
    fn from(entity: MailServer) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            name: entity.name,
            from_filter: entity.from_filter,
            smtp_host: entity.smtp_host,
            created_at,
        }
    }
}

impl From<CreateMailServerDto> for MailServer {
    fn from(dto: CreateMailServerDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            name: dto.name,
            from_filter: dto.from_filter,
            smtp_host: dto.smtp_host,
            smtp_port: dto.smtp_port,
            smtp_authentication: dto.smtp_authentication,
            smtp_user: dto.smtp_user,
            smtp_pass_ref: dto.smtp_pass_ref,
            smtp_encryption: dto.smtp_encryption,
            smtp_debug: dto.smtp_debug,
            sequence: dto.sequence,
            active: dto.active,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&MailServer> for MailServerResponseDto {
    fn from(entity: &MailServer) -> Self {
        Self {
            id: entity.id.clone(),
            name: entity.name.clone(),
            from_filter: entity.from_filter.clone(),
            smtp_host: entity.smtp_host.clone(),
            smtp_port: entity.smtp_port.clone(),
            smtp_authentication: entity.smtp_authentication.clone(),
            smtp_user: entity.smtp_user.clone(),
            smtp_pass_ref: entity.smtp_pass_ref.clone(),
            smtp_encryption: entity.smtp_encryption.clone(),
            smtp_debug: entity.smtp_debug.clone(),
            sequence: entity.sequence.clone(),
            active: entity.active.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdateMailServerDto> for MailServer {
    fn apply_update(mut self, dto: UpdateMailServerDto) -> backbone_core::ServiceResult<Self> {
        self.name = dto.name;
        self.from_filter = dto.from_filter;
        self.smtp_host = dto.smtp_host;
        self.smtp_port = dto.smtp_port;
        self.smtp_authentication = dto.smtp_authentication;
        self.smtp_user = dto.smtp_user;
        self.smtp_pass_ref = dto.smtp_pass_ref;
        self.smtp_encryption = dto.smtp_encryption;
        self.smtp_debug = dto.smtp_debug;
        self.sequence = dto.sequence;
        self.active = dto.active;
        Ok(self)
    }
}

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

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