backbone-pos 0.7.2

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

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

/// Request DTO for creating a new PosInvoiceItem
///
/// 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 CreatePosInvoiceItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "pos_invoice_id")]
    pub pos_invoice_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    #[cfg_attr(feature = "validation", validate(length(max = 300)))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "client_uuid")]
    pub client_uuid: Option<Uuid>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub course: Option<i32>,
    pub quantity: Decimal,
    #[serde(alias = "unit_price")]
    pub unit_price: Decimal,
    #[serde(alias = "discount_amount")]
    pub discount_amount: Decimal,
    #[serde(alias = "net_amount")]
    pub net_amount: Decimal,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "revenue_account_id")]
    pub revenue_account_id: Option<Uuid>,
}

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

/// Request DTO for full update of a PosInvoiceItem
///
/// 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 UpdatePosInvoiceItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "pos_invoice_id")]
    pub pos_invoice_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    #[cfg_attr(feature = "validation", validate(length(max = 300)))]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub course: Option<i32>,
    pub quantity: Decimal,
    #[serde(alias = "unit_price")]
    pub unit_price: Decimal,
    #[serde(alias = "discount_amount")]
    pub discount_amount: Decimal,
    #[serde(default, skip_serializing_if = "Option::is_none", alias = "revenue_account_id")]
    pub revenue_account_id: Option<Uuid>,
}

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

/// Request DTO for partial update of a PosInvoiceItem
///
/// 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 PatchPosInvoiceItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "pos_invoice_id")]
    pub pos_invoice_id: Option<Uuid>,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "item_id")]
    pub item_id: Option<Uuid>,
    #[cfg_attr(feature = "validation", validate(length(max = 300)))]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub course: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "unit_price")]
    pub unit_price: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "discount_amount")]
    pub discount_amount: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none", alias = "revenue_account_id")]
    pub revenue_account_id: Option<Uuid>,
}

impl PatchPosInvoiceItemDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.pos_invoice_id.is_some() || self.item_id.is_some() || self.description.is_some() || self.course.is_some() || self.quantity.is_some() || self.unit_price.is_some() || self.discount_amount.is_some() || self.revenue_account_id.is_some()
    }
}

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

/// Response DTO for PosInvoiceItem 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 PosInvoiceItemResponseDto {
    #[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_invoice_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub item_id: Uuid,
    pub description: Option<String>,
    pub client_uuid: Option<Uuid>,
    pub course: Option<i32>,
    pub quantity: Decimal,
    pub unit_price: Decimal,
    pub discount_amount: Decimal,
    pub net_amount: Decimal,
    pub revenue_account_id: Option<Uuid>,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for PosInvoiceItem 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 PosInvoiceItemListResponseDto {
    /// List of items
    pub items: Vec<PosInvoiceItemResponseDto>,
    /// 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 PosInvoiceItemListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<PosInvoiceItemResponseDto>, 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 PosInvoiceItemSummaryDto {
    pub id: Uuid,
    pub pos_invoice_id: Uuid,
    pub item_id: Uuid,
    pub description: Option<String>,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<PosInvoiceItem> for PosInvoiceItemResponseDto {
    fn from(entity: PosInvoiceItem) -> Self {
        Self {
            id: entity.id,
            pos_invoice_id: entity.pos_invoice_id,
            item_id: entity.item_id,
            description: entity.description,
            client_uuid: entity.client_uuid,
            course: entity.course,
            quantity: entity.quantity,
            unit_price: entity.unit_price,
            discount_amount: entity.discount_amount,
            net_amount: entity.net_amount,
            revenue_account_id: entity.revenue_account_id,
            metadata: entity.metadata,
        }
    }
}

impl From<PosInvoiceItem> for PosInvoiceItemSummaryDto {
    fn from(entity: PosInvoiceItem) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            pos_invoice_id: entity.pos_invoice_id,
            item_id: entity.item_id,
            description: entity.description,
            created_at,
        }
    }
}

impl From<CreatePosInvoiceItemDto> for PosInvoiceItem {
    fn from(dto: CreatePosInvoiceItemDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            pos_invoice_id: dto.pos_invoice_id,
            item_id: dto.item_id,
            description: dto.description,
            client_uuid: dto.client_uuid,
            course: dto.course,
            quantity: dto.quantity,
            unit_price: dto.unit_price,
            discount_amount: dto.discount_amount,
            net_amount: dto.net_amount,
            revenue_account_id: dto.revenue_account_id,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&PosInvoiceItem> for PosInvoiceItemResponseDto {
    fn from(entity: &PosInvoiceItem) -> Self {
        Self {
            id: entity.id.clone(),
            pos_invoice_id: entity.pos_invoice_id.clone(),
            item_id: entity.item_id.clone(),
            description: entity.description.clone(),
            client_uuid: entity.client_uuid.clone(),
            course: entity.course.clone(),
            quantity: entity.quantity.clone(),
            unit_price: entity.unit_price.clone(),
            discount_amount: entity.discount_amount.clone(),
            net_amount: entity.net_amount.clone(),
            revenue_account_id: entity.revenue_account_id.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdatePosInvoiceItemDto> for PosInvoiceItem {
    fn apply_update(mut self, dto: UpdatePosInvoiceItemDto) -> backbone_core::ServiceResult<Self> {
        self.pos_invoice_id = dto.pos_invoice_id;
        self.item_id = dto.item_id;
        self.description = dto.description;
        self.course = dto.course;
        self.quantity = dto.quantity;
        self.unit_price = dto.unit_price;
        self.discount_amount = dto.discount_amount;
        self.revenue_account_id = dto.revenue_account_id;
        Ok(self)
    }
}

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

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