bo4e_core/bo/
offer.rs

1//! Offer (Angebot) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{OfferVariant, TimePeriod};
7use crate::enums::{Division, OfferStatus};
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// An offer/quote for energy supply or services.
11///
12/// German: Angebot
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::Offer;
18/// use bo4e_core::enums::{Division, OfferStatus};
19///
20/// let offer = Offer {
21///     offer_number: Some("A-2024-001".to_string()),
22///     status: Some(OfferStatus::Binding),
23///     division: Some(Division::Electricity),
24///     ..Default::default()
25/// };
26/// ```
27#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
29#[cfg_attr(feature = "json-schema", schemars(rename = "Angebot"))]
30#[serde(rename_all = "camelCase")]
31pub struct Offer {
32    /// BO4E metadata
33    #[serde(flatten)]
34    pub meta: Bo4eMeta,
35
36    /// Offer number (Angebotsnummer)
37    #[serde(skip_serializing_if = "Option::is_none")]
38    #[cfg_attr(feature = "json-schema", schemars(rename = "angebotsnummer"))]
39    pub offer_number: Option<String>,
40
41    /// Description (Beschreibung)
42    #[serde(skip_serializing_if = "Option::is_none")]
43    #[cfg_attr(feature = "json-schema", schemars(rename = "beschreibung"))]
44    pub description: Option<String>,
45
46    /// Status of offer (Angebotsstatus)
47    #[serde(skip_serializing_if = "Option::is_none")]
48    #[cfg_attr(feature = "json-schema", schemars(rename = "angebotsstatus"))]
49    pub status: Option<OfferStatus>,
50
51    /// Energy division (Sparte)
52    #[serde(skip_serializing_if = "Option::is_none")]
53    #[cfg_attr(feature = "json-schema", schemars(rename = "sparte"))]
54    pub division: Option<Division>,
55
56    /// Date the offer was created (Angebotsdatum)
57    #[serde(skip_serializing_if = "Option::is_none")]
58    #[cfg_attr(feature = "json-schema", schemars(rename = "angebotsdatum"))]
59    pub offer_date: Option<DateTime<Utc>>,
60
61    /// Date until which the offer is valid (Gueltig bis)
62    #[serde(skip_serializing_if = "Option::is_none")]
63    #[cfg_attr(feature = "json-schema", schemars(rename = "gueltigBis"))]
64    pub valid_until: Option<DateTime<Utc>>,
65
66    /// Delivery period (Lieferzeitraum)
67    #[serde(skip_serializing_if = "Option::is_none")]
68    #[cfg_attr(feature = "json-schema", schemars(rename = "lieferzeitraum"))]
69    pub delivery_period: Option<TimePeriod>,
70
71    /// Offer variants (Angebotsvarianten)
72    #[serde(default, skip_serializing_if = "Vec::is_empty")]
73    #[cfg_attr(feature = "json-schema", schemars(rename = "angebotsvarianten"))]
74    pub variants: Vec<OfferVariant>,
75
76    /// Reference to the bidder/supplier (Anbieter)
77    #[serde(skip_serializing_if = "Option::is_none")]
78    #[cfg_attr(feature = "json-schema", schemars(rename = "anbieter"))]
79    pub bidder: Option<Box<super::BusinessPartner>>,
80
81    /// Reference to the customer (Kunde)
82    #[serde(skip_serializing_if = "Option::is_none")]
83    #[cfg_attr(feature = "json-schema", schemars(rename = "kunde"))]
84    pub customer: Option<Box<super::BusinessPartner>>,
85
86    /// Reference to associated tender (Ausschreibung)
87    #[serde(skip_serializing_if = "Option::is_none")]
88    #[cfg_attr(feature = "json-schema", schemars(rename = "ausschreibungId"))]
89    pub tender_id: Option<String>,
90}
91
92impl Bo4eObject for Offer {
93    fn type_name_german() -> &'static str {
94        "Angebot"
95    }
96
97    fn type_name_english() -> &'static str {
98        "Offer"
99    }
100
101    fn meta(&self) -> &Bo4eMeta {
102        &self.meta
103    }
104
105    fn meta_mut(&mut self) -> &mut Bo4eMeta {
106        &mut self.meta
107    }
108}
109
110#[cfg(test)]
111mod tests {
112    use super::*;
113
114    #[test]
115    fn test_offer_creation() {
116        let offer = Offer {
117            offer_number: Some("A-2024-001".to_string()),
118            status: Some(OfferStatus::Binding),
119            division: Some(Division::Electricity),
120            ..Default::default()
121        };
122
123        assert_eq!(offer.status, Some(OfferStatus::Binding));
124    }
125
126    #[test]
127    fn test_offer_with_variants() {
128        let variant = OfferVariant {
129            offer_status: Some(OfferStatus::NonBinding),
130            parts_count: Some(3),
131            ..Default::default()
132        };
133
134        let offer = Offer {
135            offer_number: Some("A-2024-001".to_string()),
136            variants: vec![variant],
137            ..Default::default()
138        };
139
140        assert_eq!(offer.variants.len(), 1);
141    }
142
143    #[test]
144    fn test_serialize() {
145        let offer = Offer {
146            meta: Bo4eMeta::with_type("Angebot"),
147            offer_number: Some("A-123".to_string()),
148            status: Some(OfferStatus::Binding),
149            ..Default::default()
150        };
151
152        let json = serde_json::to_string(&offer).unwrap();
153        assert!(json.contains(r#""offerNumber":"A-123""#));
154    }
155
156    #[test]
157    fn test_roundtrip() {
158        let offer = Offer {
159            meta: Bo4eMeta::with_type("Angebot"),
160            offer_number: Some("A-123".to_string()),
161            description: Some("Test offer".to_string()),
162            status: Some(OfferStatus::Binding),
163            division: Some(Division::Electricity),
164            ..Default::default()
165        };
166
167        let json = serde_json::to_string(&offer).unwrap();
168        let parsed: Offer = serde_json::from_str(&json).unwrap();
169        assert_eq!(offer, parsed);
170    }
171
172    #[test]
173    fn test_bo4e_object_impl() {
174        assert_eq!(Offer::type_name_german(), "Angebot");
175        assert_eq!(Offer::type_name_english(), "Offer");
176    }
177}
bo4e_core/bo/offer.rs

bo4e_core/bo/
offer.rs
