Fix inconsistencies in OMI group

Author: BerriJ

src/entsoe/OMI/OMI.py

@@ -10,10 +10,9 @@ class OMI(Base):
     def __init__(
         self,
         security_token: str,
+        control_area_domain: str,  # Required - EIC code of Scheduling Area
         period_start: Optional[int] = None,
         period_end: Optional[int] = None,
-        # Domain parameters - required based on query type
-        control_area_domain: Optional[str] = None,
         # Alternative period parameters for update-based queries
         period_start_update: Optional[int] = None,
         period_end_update: Optional[int] = None,
@@ -30,11 +29,11 @@ def __init__(
 
         Args:
             security_token: API security token
+            control_area_domain: EIC code of Scheduling Area (required)
             period_start: Start period (YYYYMMDDHHMM format, optional if
-                         period_start_update is defined)
+                         period_start_update and period_end_update are defined)
             period_end: End period (YYYYMMDDHHMM format, optional if
-                       period_end_update is defined)
-            control_area_domain: EIC code of Scheduling Area (typically required)
+                       period_start_update and period_end_update are defined)
             period_start_update: Start of update period (YYYYMMDDHHMM format,
                                mandatory if period_start and period_end not defined)
             period_end_update: End of update period (YYYYMMDDHHMM format,
@@ -48,13 +47,17 @@ def __init__(
 
         Raises:
             ValueError: If doc_status is not one of A05, A09, A13
+            ValueError: If neither (period_start, period_end) nor
+                       (period_start_update, period_end_update) are provided
 
         Notes:
             - Document type is fixed to B47 (Other Market Information)
             - Used for various market notifications and information not covered
               by other specific document types
             - Supports both standard period queries and update-based queries
             - Time range limitations may apply depending on query type
+            - Either (period_start, period_end) OR (period_start_update,
+              period_end_update) must be provided
         """
         # Validate doc_status if provided
         if doc_status is not None:
@@ -64,25 +67,33 @@ def __init__(
                     f"doc_status must be one of {valid_statuses}, got: {doc_status}"
                 )
 
+        # Validate that either (period_start, period_end) or
+        # (period_start_update, period_end_update) are provided
+        has_period = period_start is not None and period_end is not None
+        has_update_period = (
+            period_start_update is not None and period_end_update is not None
+        )
+
+        if not has_period and not has_update_period:
+            raise ValueError(
+                "Either (period_start, period_end) or "
+                "(period_start_update, period_end_update) must be provided"
+            )
+
         # Initialize base parameters using proper encapsulation
         super().__init__(
             document_type="B47",  # Fixed to B47 for Other Market Information
             security_token=security_token,
             period_start=period_start,
             period_end=period_end,
             timeout=timeout,
-            offset=offset,
+            offset=0,  # Don't pass offset to base, we'll handle it with correct name
         )
 
-        # Add update period parameters
-        self.add_update_params(
-            period_start_update=period_start_update,
-            period_end_update=period_end_update,
-        )
-
-        # Add domain parameters
-        self.add_domain_params(control_area_domain=control_area_domain)
-
-        # Add OMI-specific parameters
-        self.add_optional_param("docStatus", doc_status)
+        # Add OMI-specific parameters using exact JSON parameter names
+        self.add_optional_param("ControlArea_Domain", control_area_domain)
+        self.add_optional_param("DocStatus", doc_status)
+        self.add_optional_param("PeriodStartUpdate", period_start_update)
+        self.add_optional_param("PeriodEndUpdate", period_end_update)
+        self.add_optional_param("Offset", offset)
         self.add_optional_param("mRID", m_rid)

tests/test_encapsulation.py

@@ -14,9 +14,9 @@ def test_omi_parameter_initialization(self):
         class methods."""
         omi = OMI(
             security_token="test_token",
+            control_area_domain="10YBE----------2",
             period_start=202301010000,
             period_end=202301020000,
-            control_area_domain="10YBE----------2",
             doc_status="A05",
             m_rid="test_mrid",
             offset=100,
@@ -27,21 +27,28 @@ class methods."""
         assert omi.params["securityToken"] == "test_token"
         assert omi.params["periodStart"] == 202301010000
         assert omi.params["periodEnd"] == 202301020000
-        assert omi.params["controlArea_Domain"] == "10YBE----------2"
-        assert omi.params["docStatus"] == "A05"
+        assert omi.params["ControlArea_Domain"] == "10YBE----------2"
+        assert omi.params["DocStatus"] == "A05"
         assert omi.params["mRID"] == "test_mrid"
-        assert omi.params["offset"] == 100
+        assert omi.params["Offset"] == 100
 
     def test_omi_optional_periods(self):
-        """Test that OMI class handles optional period parameters correctly."""
+        """Test that OMI class handles period parameters correctly - either
+        standard or update periods must be provided."""
+        # Test with update periods instead of standard periods
         omi = OMI(
             security_token="test_token",
             control_area_domain="10YBE----------2",
+            period_start_update=202301010000,
+            period_end_update=202301020000,
         )
 
-        # Verify that optional period parameters are not included
+        # Verify that standard period parameters are not included
         assert "periodStart" not in omi.params
         assert "periodEnd" not in omi.params
+        # But update period parameters should be included
+        assert omi.params["PeriodStartUpdate"] == 202301010000
+        assert omi.params["PeriodEndUpdate"] == 202301020000
         assert omi.params["documentType"] == "B47"
         assert omi.params["securityToken"] == "test_token"
 
@@ -92,7 +99,20 @@ def test_omi_validation_error(self):
         with pytest.raises(ValueError, match="doc_status must be one of"):
             OMI(
                 security_token="test_token",
-                doc_status="INVALID",
+                control_area_domain="10YBE----------2",
+                period_start=202301010000,
+                period_end=202301020000,
+                doc_status="INVALID",  # type: ignore
+            )
+
+    def test_omi_period_validation_error(self):
+        """Test that OMI class requires either standard or update periods."""
+        with pytest.raises(
+            ValueError, match="Either \\(period_start, period_end\\) or"
+        ):
+            OMI(
+                security_token="test_token",
+                control_area_domain="10YBE----------2",
             )
 
     def test_encapsulation_no_direct_params_access(self):
@@ -101,6 +121,8 @@ def test_encapsulation_no_direct_params_access(self):
         omi = OMI(
             security_token="test_token",
             control_area_domain="10YBE----------2",
+            period_start=202301010000,
+            period_end=202301020000,
         )
 
         # The params dictionary should be properly initialized through Base