bo4e-core 0.2.0

Core types for BO4E (Business Objects for Energy)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! Service price sheet (PreisblattDienstleistung) business object.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::com::{ServicePrice, TimePeriod};
use crate::enums::{Division, ServiceType};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// A price sheet for services (e.g., metering, billing).
///
/// German: PreisblattDienstleistung
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::ServicePriceSheet;
/// use bo4e_core::enums::{Division, ServiceType};
///
/// let price_sheet = ServicePriceSheet {
///     designation: Some("Dienstleistungspreisblatt 2024".to_string()),
///     division: Some(Division::Electricity),
///     service_type: Some(ServiceType::RemoteReading),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "json-schema", schemars(rename = "PreisblattDienstleistung"))]
#[serde(rename_all = "camelCase")]
pub struct ServicePriceSheet {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Name/designation of the price sheet (Bezeichnung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "bezeichnung"))]
    pub designation: Option<String>,

    /// Description (Beschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "beschreibung"))]
    pub description: Option<String>,

    /// Energy division (Sparte)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "sparte"))]
    pub division: Option<Division>,

    /// Type of service (Dienstleistungsart)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "dienstleistungsart"))]
    pub service_type: Option<ServiceType>,

    /// Price sheet number/identifier (Preisblattnummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "preisblattnummer"))]
    pub price_sheet_number: Option<String>,

    /// Validity period (Gueltigkeitszeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigkeitszeitraum"))]
    pub validity_period: Option<TimePeriod>,

    /// Valid from date (Gueltig ab)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigAb"))]
    pub valid_from: Option<DateTime<Utc>>,

    /// Valid until date (Gueltig bis)
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigBis"))]
    pub valid_until: Option<DateTime<Utc>>,

    /// Service prices (Dienstleistungspreise)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "dienstleistungspreise"))]
    pub prices: Vec<ServicePrice>,

    /// Service provider
    #[serde(skip_serializing_if = "Option::is_none")]
    #[cfg_attr(feature = "json-schema", schemars(rename = "dienstleister"))]
    pub provider: Option<Box<super::BusinessPartner>>,
}

impl Bo4eObject for ServicePriceSheet {
    fn type_name_german() -> &'static str {
        "PreisblattDienstleistung"
    }

    fn type_name_english() -> &'static str {
        "ServicePriceSheet"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_service_price_sheet_creation() {
        let price_sheet = ServicePriceSheet {
            designation: Some("Dienstleistungspreisblatt 2024".to_string()),
            division: Some(Division::Electricity),
            service_type: Some(ServiceType::RemoteReading),
            price_sheet_number: Some("DL-2024-001".to_string()),
            ..Default::default()
        };

        assert_eq!(price_sheet.service_type, Some(ServiceType::RemoteReading));
    }

    #[test]
    fn test_serialize() {
        let price_sheet = ServicePriceSheet {
            meta: Bo4eMeta::with_type("PreisblattDienstleistung"),
            designation: Some("Service Prices".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&price_sheet).unwrap();
        assert!(json.contains(r#""designation":"Service Prices""#));
        assert!(json.contains(r#""_typ":"PreisblattDienstleistung""#));
    }

    #[test]
    fn test_roundtrip() {
        let price_sheet = ServicePriceSheet {
            meta: Bo4eMeta::with_type("PreisblattDienstleistung"),
            designation: Some("Billing Services".to_string()),
            description: Some("Standard billing service prices".to_string()),
            division: Some(Division::Electricity),
            price_sheet_number: Some("BS-2024".to_string()),
            ..Default::default()
        };

        let json = serde_json::to_string(&price_sheet).unwrap();
        let parsed: ServicePriceSheet = serde_json::from_str(&json).unwrap();
        assert_eq!(price_sheet, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(
            ServicePriceSheet::type_name_german(),
            "PreisblattDienstleistung"
        );
        assert_eq!(ServicePriceSheet::type_name_english(), "ServicePriceSheet");
    }
}