backbone-mail 0.2.32

//! SmsTracker 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::SmsTracker;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::MailNotificationStatus;
use crate::domain::entity::NotificationFailureType;

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

/// Request DTO for creating a new SmsTracker
///
/// 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 CreateSmsTrackerDto {
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(alias = "sms_uuid")]
    pub sms_uuid: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "message_id")]
    pub message_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "notification_id")]
    pub notification_id: Option<Uuid>,
    pub state: MailNotificationStatus,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_type")]
    pub failure_type: Option<NotificationFailureType>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_reason")]
    pub failure_reason: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub recipient: Option<String>,
}

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

/// Request DTO for full update of a SmsTracker
///
/// 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 UpdateSmsTrackerDto {
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(alias = "sms_uuid")]
    pub sms_uuid: String,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "message_id")]
    pub message_id: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "notification_id")]
    pub notification_id: Option<Uuid>,
    pub state: MailNotificationStatus,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_type")]
    pub failure_type: Option<NotificationFailureType>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "failure_reason")]
    pub failure_reason: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub recipient: Option<String>,
}

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

/// Request DTO for partial update of a SmsTracker
///
/// 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 PatchSmsTrackerDto {
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "sms_uuid")]
    pub sms_uuid: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "message_id")]
    pub message_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "notification_id")]
    pub notification_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<MailNotificationStatus>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "failure_type")]
    pub failure_type: Option<NotificationFailureType>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "failure_reason")]
    pub failure_reason: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub recipient: Option<String>,
}

impl PatchSmsTrackerDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.sms_uuid.is_some() || self.message_id.is_some() || self.notification_id.is_some() || self.state.is_some() || self.failure_type.is_some() || self.failure_reason.is_some() || self.recipient.is_some()
    }
}

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

/// Response DTO for SmsTracker 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 SmsTrackerResponseDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "example"))]
    pub sms_uuid: String,
    pub message_id: Option<Uuid>,
    pub notification_id: Option<Uuid>,
    pub state: MailNotificationStatus,
    pub failure_type: Option<NotificationFailureType>,
    pub failure_reason: Option<String>,
    pub recipient: Option<String>,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for SmsTracker 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 SmsTrackerListResponseDto {
    /// List of items
    pub items: Vec<SmsTrackerResponseDto>,
    /// 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 SmsTrackerListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<SmsTrackerResponseDto>, 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 SmsTrackerSummaryDto {
    pub id: Uuid,
    pub sms_uuid: String,
    pub message_id: Option<Uuid>,
    pub notification_id: Option<Uuid>,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<SmsTracker> for SmsTrackerResponseDto {
    fn from(entity: SmsTracker) -> Self {
        Self {
            id: entity.id,
            sms_uuid: entity.sms_uuid,
            message_id: entity.message_id,
            notification_id: entity.notification_id,
            state: entity.state,
            failure_type: entity.failure_type,
            failure_reason: entity.failure_reason,
            recipient: entity.recipient,
            metadata: entity.metadata,
        }
    }
}

impl From<SmsTracker> for SmsTrackerSummaryDto {
    fn from(entity: SmsTracker) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            sms_uuid: entity.sms_uuid,
            message_id: entity.message_id,
            notification_id: entity.notification_id,
            created_at,
        }
    }
}

impl From<CreateSmsTrackerDto> for SmsTracker {
    fn from(dto: CreateSmsTrackerDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            sms_uuid: dto.sms_uuid,
            message_id: dto.message_id,
            notification_id: dto.notification_id,
            state: dto.state,
            failure_type: dto.failure_type,
            failure_reason: dto.failure_reason,
            recipient: dto.recipient,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&SmsTracker> for SmsTrackerResponseDto {
    fn from(entity: &SmsTracker) -> Self {
        Self {
            id: entity.id.clone(),
            sms_uuid: entity.sms_uuid.clone(),
            message_id: entity.message_id.clone(),
            notification_id: entity.notification_id.clone(),
            state: entity.state.clone(),
            failure_type: entity.failure_type.clone(),
            failure_reason: entity.failure_reason.clone(),
            recipient: entity.recipient.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdateSmsTrackerDto> for SmsTracker {
    fn apply_update(mut self, dto: UpdateSmsTrackerDto) -> backbone_core::ServiceResult<Self> {
        self.sms_uuid = dto.sms_uuid;
        self.message_id = dto.message_id;
        self.notification_id = dto.notification_id;
        self.state = dto.state;
        self.failure_type = dto.failure_type;
        self.failure_reason = dto.failure_reason;
        self.recipient = dto.recipient;
        Ok(self)
    }
}

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

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