backbone-inventory 0.17.2

Inventory: stock ledger of record (SLE) + moving-average valuation; emits COGS/asset AccountingPost (Delivery/Receipt -> GL)
Documentation
//! PurchaseReceiptItem DTOs (Data Transfer Objects)
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! DTOs provide a clean separation between domain entities and API
//! representations, with 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;

use crate::domain::entity::PurchaseReceiptItem;
use crate::domain::entity::AuditMetadata;

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

/// Request DTO for creating a new PurchaseReceiptItem
///
/// 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))]
#[serde(rename_all = "camelCase")]
pub struct CreatePurchaseReceiptItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "receipt_id")]
    pub receipt_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    pub quantity: Decimal,
    pub rate: Decimal,
    pub amount: Decimal,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "is_landed_costs_line")]
    pub is_landed_costs_line: bool,
}

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

/// Request DTO for full update of a PurchaseReceiptItem
///
/// 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))]
#[serde(rename_all = "camelCase")]
pub struct UpdatePurchaseReceiptItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "receipt_id")]
    pub receipt_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(alias = "item_id")]
    pub item_id: Uuid,
    pub quantity: Decimal,
    pub rate: Decimal,
    pub amount: Decimal,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(alias = "is_landed_costs_line")]
    pub is_landed_costs_line: bool,
}

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

/// Request DTO for partial update of a PurchaseReceiptItem
///
/// 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))]
#[serde(rename_all = "camelCase")]
pub struct PatchPurchaseReceiptItemDto {
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "receipt_id")]
    pub receipt_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>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantity: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rate: Option<Decimal>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub amount: Option<Decimal>,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    #[serde(skip_serializing_if = "Option::is_none", alias = "is_landed_costs_line")]
    pub is_landed_costs_line: Option<bool>,
}

impl PatchPurchaseReceiptItemDto {
    /// Check if any field is set
    pub fn has_changes(&self) -> bool {
        self.receipt_id.is_some() || self.item_id.is_some() || self.quantity.is_some() || self.rate.is_some() || self.amount.is_some() || self.is_landed_costs_line.is_some()
    }
}

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

/// Response DTO for PurchaseReceiptItem 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 PurchaseReceiptItemResponseDto {
    #[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 receipt_id: Uuid,
    #[cfg_attr(feature = "openapi", schema(example = "550e8400-e29b-41d4-a716-446655440000"))]
    pub item_id: Uuid,
    pub quantity: Decimal,
    pub rate: Decimal,
    pub amount: Decimal,
    #[cfg_attr(feature = "openapi", schema(example = true))]
    pub is_landed_costs_line: bool,
    pub metadata: AuditMetadata,
}

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

/// Paginated list response for PurchaseReceiptItem 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 PurchaseReceiptItemListResponseDto {
    /// List of items
    pub items: Vec<PurchaseReceiptItemResponseDto>,
    /// 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 PurchaseReceiptItemListResponseDto {
    /// Create a new list response from items and pagination info
    pub fn new(items: Vec<PurchaseReceiptItemResponseDto>, 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 PurchaseReceiptItemSummaryDto {
    pub id: Uuid,
    pub receipt_id: Uuid,
    pub item_id: Uuid,
    pub quantity: Decimal,
    pub created_at: Option<DateTime<Utc>>,
}

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

impl From<PurchaseReceiptItem> for PurchaseReceiptItemResponseDto {
    fn from(entity: PurchaseReceiptItem) -> Self {
        Self {
            id: entity.id,
            receipt_id: entity.receipt_id,
            item_id: entity.item_id,
            quantity: entity.quantity,
            rate: entity.rate,
            amount: entity.amount,
            is_landed_costs_line: entity.is_landed_costs_line,
            metadata: entity.metadata,
        }
    }
}

impl From<PurchaseReceiptItem> for PurchaseReceiptItemSummaryDto {
    fn from(entity: PurchaseReceiptItem) -> Self {
        let created_at = backbone_core::PersistentEntity::created_at(&entity);
        Self {
            id: entity.id,
            receipt_id: entity.receipt_id,
            item_id: entity.item_id,
            quantity: entity.quantity,
            created_at,
        }
    }
}

impl From<CreatePurchaseReceiptItemDto> for PurchaseReceiptItem {
    fn from(dto: CreatePurchaseReceiptItemDto) -> Self {
        Self {
            id: Uuid::new_v4(),
            receipt_id: dto.receipt_id,
            item_id: dto.item_id,
            quantity: dto.quantity,
            rate: dto.rate,
            amount: dto.amount,
            is_landed_costs_line: dto.is_landed_costs_line,
            metadata: AuditMetadata::default(),
        }
    }
}

impl From<&PurchaseReceiptItem> for PurchaseReceiptItemResponseDto {
    fn from(entity: &PurchaseReceiptItem) -> Self {
        Self {
            id: entity.id.clone(),
            receipt_id: entity.receipt_id.clone(),
            item_id: entity.item_id.clone(),
            quantity: entity.quantity.clone(),
            rate: entity.rate.clone(),
            amount: entity.amount.clone(),
            is_landed_costs_line: entity.is_landed_costs_line.clone(),
            metadata: entity.metadata.clone(),
        }
    }
}

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

impl backbone_core::ApplyUpdateDto<UpdatePurchaseReceiptItemDto> for PurchaseReceiptItem {
    fn apply_update(mut self, dto: UpdatePurchaseReceiptItemDto) -> backbone_core::ServiceResult<Self> {
        self.receipt_id = dto.receipt_id;
        self.item_id = dto.item_id;
        self.quantity = dto.quantity;
        self.rate = dto.rate;
        self.amount = dto.amount;
        self.is_landed_costs_line = dto.is_landed_costs_line;
        Ok(self)
    }
}

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

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