backbone-pos 0.7.2

Point of sale — cashier session, ticket + multi-tender; orchestrates billing (revenue) + payment (settlement), posts no GL directly
Documentation
//! PosCashMovement 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};
use rust_decimal::Decimal;

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

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

use crate::domain::entity::PosCashMovement;
use crate::domain::entity::AuditMetadata;
use crate::domain::entity::PosCashMovementType;

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

/// Request DTO for creating a new PosCashMovement
///
/// 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 CreatePosCashMovementDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "pos_profile_id")]
    pub pos_profile_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "opening_entry_id")]
    pub opening_entry_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "cashier_party_id")]
    pub cashier_party_id: Uuid,
    #[serde(alias = "movement_type")]
    pub movement_type: PosCashMovementType,
    pub amount: Decimal,
    #[cfg_attr(feature = "validation", validate(length(max = 300)))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    #[serde(alias = "moved_at")]
    pub moved_at: DateTime<Utc>,
}

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

/// Request DTO for full update of a PosCashMovement
///
/// 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 UpdatePosCashMovementDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "pos_profile_id")]
    pub pos_profile_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "opening_entry_id")]
    pub opening_entry_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "cashier_party_id")]
    pub cashier_party_id: Uuid,
    #[serde(alias = "movement_type")]
    pub movement_type: PosCashMovementType,
    pub amount: Decimal,
    #[cfg_attr(feature = "validation", validate(length(max = 300)))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    #[serde(alias = "moved_at")]
    pub moved_at: DateTime<Utc>,
}

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

/// Request DTO for partial update of a PosCashMovement
///
/// 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 PatchPosCashMovementDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "pos_profile_id")]
    pub pos_profile_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "opening_entry_id")]
    pub opening_entry_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "cashier_party_id")]
    pub cashier_party_id: Option<Uuid>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "movement_type")]
    pub movement_type: Option<PosCashMovementType>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<Decimal>,
    #[cfg_attr(feature = "validation", validate(length(max = 300)))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "moved_at")]
    pub moved_at: Option<DateTime<Utc>>,
}

impl PatchPosCashMovementDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.pos_profile_id.is_some() || self.opening_entry_id.is_some() || self.cashier_party_id.is_some() || self.movement_type.is_some() || self.amount.is_some() || self.reason.is_some() || self.moved_at.is_some()
    }
}

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

/// Response DTO for PosCashMovement 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 PosCashMovementResponseDto {
    #[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 pos_profile_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub opening_entry_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub cashier_party_id: Uuid,
    pub movement_type: PosCashMovementType,
    pub amount: Decimal,
    pub reason: Option<String>,
    #[cfg_attr(feature = "openapi", schema(example = "2024-01-01T00:00:00Z"))]
    pub moved_at: DateTime<Utc>,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for PosCashMovement 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 PosCashMovementListResponseDto {
    /// List of items
    pub items: Vec<PosCashMovementResponseDto>,
    /// 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 PosCashMovementListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<PosCashMovementResponseDto>, 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 PosCashMovementSummaryDto {
    pub id: Uuid,
    pub pos_profile_id: Uuid,
    pub opening_entry_id: Uuid,
    pub cashier_party_id: Uuid,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<PosCashMovement> for PosCashMovementResponseDto {
    fn from(entity: PosCashMovement) -> Self {
        Self {
            id: entity.id,
            pos_profile_id: entity.pos_profile_id,
            opening_entry_id: entity.opening_entry_id,
            cashier_party_id: entity.cashier_party_id,
            movement_type: entity.movement_type,
            amount: entity.amount,
            reason: entity.reason,
            moved_at: entity.moved_at,
            metadata: entity.metadata,
        }
    }
}

impl From<PosCashMovement> for PosCashMovementSummaryDto {
    fn from(entity: PosCashMovement) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            pos_profile_id: entity.pos_profile_id,
            opening_entry_id: entity.opening_entry_id,
            cashier_party_id: entity.cashier_party_id,
            created_at,
        }
    }
}

impl From<CreatePosCashMovementDto> for PosCashMovement {
    fn from(dto: CreatePosCashMovementDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            pos_profile_id: dto.pos_profile_id,
            opening_entry_id: dto.opening_entry_id,
            cashier_party_id: dto.cashier_party_id,
            movement_type: dto.movement_type,
            amount: dto.amount,
            reason: dto.reason,
            moved_at: dto.moved_at,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&PosCashMovement> for PosCashMovementResponseDto {
    fn from(entity: &PosCashMovement) -> Self {
        Self {
            id: entity.id.clone(),
            pos_profile_id: entity.pos_profile_id.clone(),
            opening_entry_id: entity.opening_entry_id.clone(),
            cashier_party_id: entity.cashier_party_id.clone(),
            movement_type: entity.movement_type.clone(),
            amount: entity.amount.clone(),
            reason: entity.reason.clone(),
            moved_at: entity.moved_at.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdatePosCashMovementDto> for PosCashMovement {
    fn apply_update(mut self, dto: UpdatePosCashMovementDto) -> backbone_core::ServiceResult<Self> {
        self.pos_profile_id = dto.pos_profile_id;
        self.opening_entry_id = dto.opening_entry_id;
        self.cashier_party_id = dto.cashier_party_id;
        self.movement_type = dto.movement_type;
        self.amount = dto.amount;
        self.reason = dto.reason;
        self.moved_at = dto.moved_at;
        Ok(self)
    }
}

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

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