mms-client 1.1.0__tar.gz → 1.3.0__tar.gz

{mms_client-1.1.0 → mms_client-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mms-client
-Version: 1.1.0
+Version: 1.3.0
 Summary: API client for accessing the MMS
 Home-page: https://github.com/ElectroRoute-Japan/mms-client
 Author: Ryan Wood
@@ -198,6 +198,7 @@ This client is not complete. Currently, it supports the following endpoints:
 - MarketSubmit_OfferData
 - MarketQuery_OfferQuery
 - MarketCancel_OfferCancel
+- MarketQuery_AwardResultsQuery
 - RegistrationSubmit_Resource
 - RegistrationQuery_Resource
 

{mms_client-1.1.0 → mms_client-1.3.0}/README.md

@@ -166,6 +166,7 @@ This client is not complete. Currently, it supports the following endpoints:
 - MarketSubmit_OfferData
 - MarketQuery_OfferQuery
 - MarketCancel_OfferCancel
+- MarketQuery_AwardResultsQuery
 - RegistrationSubmit_Resource
 - RegistrationQuery_Resource
 

{mms_client-1.1.0 → mms_client-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mms_client"
-version = "v1.1.0"
+version = "v1.3.0"
 description = "API client for accessing the MMS"
 authors = ["Ryan Wood <ryan.wood@electroroute.co.jp>"]
 readme = "README.md"

{mms_client-1.1.0 → mms_client-1.3.0}/src/mms_client/services/base.py

@@ -10,6 +10,7 @@ from typing import Optional
 from typing import Protocol
 from typing import Tuple
 from typing import Type
+from typing import Union
 
 from mms_client.security.crypto import Certificate
 from mms_client.security.crypto import CryptoWrapper
@@ -119,7 +120,7 @@ class ClientProto(Protocol):
     def request_many(
         self,
         envelope: E,
-        data: P,
+        data: Union[P, List[P]],
         config: EndpointConfiguration,
     ) -> Tuple[MultiResponse[E, P], Dict[str, bytes]]:
         """Submit a request to the MMS server and return the multi-response.
@@ -361,7 +362,7 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
     def request_many(
         self,
         envelope: E,
-        payload: P,
+        payload: Union[P, List[P]],
         config: EndpointConfiguration[E, P],
     ) -> Tuple[MultiResponse[E, P], Dict[str, bytes]]:
         """Submit a request to the MMS server and return the multi-response.
@@ -374,13 +375,20 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
         Returns:    The multi-response from the MMS server.
         """
         # First, create the MMS request from the payload and data.
+        is_list = isinstance(payload, list)
+        data_type = type(payload[0]) if is_list else type(payload)  # type: ignore[index]
         self._logger.debug(
             (
                 f"{config.name}: Starting multi-request. Envelope: {type(envelope).__name__}, "
-                f"Data: {type(payload).__name__}"
+                f"Data: {data_type.__name__}"
             ),
         )
-        request = self._to_mms_request(config.request_type, config.service.serializer.serialize(envelope, payload))
+        serialized = (
+            config.service.serializer.serialize_multi(envelope, payload, data_type)  # type: ignore[arg-type]
+            if is_list
+            else config.service.serializer.serialize(envelope, payload)  # type: ignore[type-var]
+        )
+        request = self._to_mms_request(config.request_type, serialized)
 
         # Next, submit the request to the MMS server and get and verify the response.
         resp = self._get_wrapper(config.service).submit(request)
@@ -391,8 +399,12 @@ class BaseClient:  # pylint: disable=too-many-instance-attributes
 
         # Finally, deserialize and verify the response
         envelope_type = config.response_envelope_type or type(envelope)
-        data_type = config.response_data_type or type(payload)
-        data: MultiResponse[E, P] = config.service.serializer.deserialize_multi(resp.payload, envelope_type, data_type)
+        data_type = config.response_data_type or data_type
+        data: MultiResponse[E, P] = config.service.serializer.deserialize_multi(
+            resp.payload,
+            envelope_type,
+            data_type,  # type: ignore[arg-type]
+        )
         self._verify_multi_response(data, config)
 
         # Return the response data and any attachments

{mms_client-1.1.0 → mms_client-1.3.0}/src/mms_client/services/market.py

@@ -8,6 +8,8 @@ from mms_client.services.base import ClientProto
 from mms_client.services.base import ServiceConfiguration
 from mms_client.services.base import mms_endpoint
 from mms_client.services.base import mms_multi_endpoint
+from mms_client.types.award import AwardQuery
+from mms_client.types.award import AwardResponse
 from mms_client.types.market import MarketCancel
 from mms_client.types.market import MarketQuery
 from mms_client.types.market import MarketSubmit
@@ -45,7 +47,33 @@ class MarketClientMixin:  # pylint: disable=unused-argument
 
         Returns:    The offer that has been registered with the MMS server.
         """
-        # Note: the return type does not match the method definition but the decorator will return the correct type
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketSubmit(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            market_type=market_type,
+            days=days,
+        )
+
+    @mms_multi_endpoint("MarketSubmit_OfferData", config, RequestType.INFO, ClientType.BSP)
+    def put_offers(
+        self: ClientProto, requests: List[OfferData], market_type: MarketType, days: int, date: Optional[Date] = None
+    ) -> List[OfferData]:
+        """Submit multiple offers to the MMS server.
+
+        This endpoint is only accessible to BSPs.
+
+        Arguments:
+        requests (List[OfferData]): The offers to submit to the MMS server.
+        market_type (MarketType):   The type of market for which the offers are being submitted.
+        days (int):                 The number of days ahead for which the offers are being submitted.
+        date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
+                                    current date.
+
+        Returns:    A list of offers that have been registered with the MMS server.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
         return MarketSubmit(  # type: ignore[return-value]
             date=date or Date.today(),
             participant=self.participant,
@@ -57,28 +85,24 @@ class MarketClientMixin:  # pylint: disable=unused-argument
     @mms_multi_endpoint(
         "MarketQuery_OfferQuery", config, RequestType.INFO, resp_envelope_type=MarketSubmit, resp_data_type=OfferData
     )
-    def query_offers(
-        self: ClientProto, request: OfferQuery, market_type: MarketType, days: int, date: Optional[Date] = None
-    ) -> List[OfferData]:
+    def query_offers(self: ClientProto, request: OfferQuery, days: int, date: Optional[Date] = None) -> List[OfferData]:
         """Query the MMS server for offers.
 
         This endpoint is accessible to all client types.
 
         Arguments:
         request (OfferQuery):       The query to submit to the MMS server.
-        market_type (MarketType):   The type of market for which the offer was submitted.
         days (int):                 The number of days ahead for which the data is being queried.
         date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
                                     current date.
 
         Returns:    A list of offers that match the query.
         """
-        # Note: the return type does not match the method definition but the decorator will return the correct type
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
         return MarketQuery(  # type: ignore[return-value]
             date=date or Date.today(),
             participant=self.participant,
             user=self.user,
-            market_type=market_type,
             days=days,
         )
 
@@ -97,7 +121,7 @@ class MarketClientMixin:  # pylint: disable=unused-argument
         date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
                                     current date.
         """
-        # Note: the return type does not match the method definition but the decorator will return the correct type
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
         return MarketCancel(  # type: ignore[return-value]
             date=date or Date.today(),
             participant=self.participant,
@@ -105,3 +129,30 @@ class MarketClientMixin:  # pylint: disable=unused-argument
             market_type=market_type,
             days=days,
         )
+
+    @mms_endpoint("MarketQuery_AwardResultsQuery", config, RequestType.INFO, resp_data_type=AwardResponse)
+    def query_awards(self: ClientProto, request: AwardQuery, days: int, date: Optional[Date] = None) -> AwardResponse:
+        """Query the MMS server for award results.
+
+        This endpoint is accessible to all client types.
+
+        If no values are specified for Area, Associated Area, Power Generation Unit Code, or GC Registration Flag,
+        the results for all areas will be retrieved. If one or more of these criteria are specified, the results will
+        be filtered according to the specified criteria. If no value is specified for the retrieval period, the default
+        value for this field is 1.
+
+        Arguments:
+        request (AwardQuery):       The query to submit to the MMS server.
+        days (int):                 The number of days ahead for which the data is being queried.
+        date (Date):                The date of the transaction in the format "YYYY-MM-DD". This value defaults to the
+                                    current date.
+
+        Returns:    The award results that match the query.
+        """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
+        return MarketQuery(  # type: ignore[return-value]
+            date=date or Date.today(),
+            participant=self.participant,
+            user=self.user,
+            days=days,
+        )

{mms_client-1.1.0 → mms_client-1.3.0}/src/mms_client/services/registration.py

@@ -38,6 +38,7 @@ class RegistrationClientMixin:  # pylint: disable=unused-argument
 
         Returns:    The resource that has been registered with the MMS server.
         """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
         # For some reason, the registration DTOs require that the participant ID exist on the payload rather than on
         # the envelope so we need to set it before we return the envelope.
         request.participant = self.participant
@@ -65,6 +66,7 @@ class RegistrationClientMixin:  # pylint: disable=unused-argument
 
         Returns:    A list of resources that match the query.
         """
+        # NOTE: The return type does not match the method definition but the decorator will return the correct type
         # For some reason, the registration DTOs require that the participant ID exist on the payload rather than on
         # the envelope so we need to set it before we return the envelope.
         request.participant = self.participant

mms_client-1.3.0/src/mms_client/types/award.py

@@ -0,0 +1,310 @@
+"""Contains objects for MMS award results."""
+
+from decimal import Decimal
+from enum import Enum
+from typing import List
+from typing import Optional
+
+from pydantic_core import PydanticUndefined
+from pydantic_extra_types.pendulum_dt import DateTime
+from pydantic_xml import attr
+from pydantic_xml import element
+from pydantic_xml import wrapped
+
+from mms_client.types.base import Payload
+from mms_client.types.enums import AreaCode
+from mms_client.types.enums import BooleanFlag
+from mms_client.types.enums import CommandMonitorMethod
+from mms_client.types.enums import ContractResult
+from mms_client.types.enums import Direction
+from mms_client.types.enums import ResourceType
+from mms_client.types.fields import company_short_name
+from mms_client.types.fields import contract_id
+from mms_client.types.fields import dr_patter_number
+from mms_client.types.fields import dr_pattern_name
+from mms_client.types.fields import jbms_id
+from mms_client.types.fields import offer_id
+from mms_client.types.fields import operator_code
+from mms_client.types.fields import participant
+from mms_client.types.fields import power_positive
+from mms_client.types.fields import price
+from mms_client.types.fields import resource_name
+from mms_client.types.fields import resource_short_name
+from mms_client.types.fields import system_code
+from mms_client.types.market import MarketType
+
+
+def baseload_file_name(alias: str, optional: bool = False):
+    """Create a field for a baseload file name.
+
+    Arguments:
+    alias (str):        The name of the alias to assign to the Pydanitc field. This value will be used to map the field
+                        to the JSON/XML key.
+    optional (bool):    If True, the field will be optional with a default of None. If False, the field will be
+                        required, with no default.
+
+    Returns:    A Pydantic Field object for the baseload file name.
+    """
+    return attr(
+        default=None if optional else PydanticUndefined,
+        name=alias,
+        min_length=31,
+        max_length=40,
+        pattern=r"^W9_[0-9]{4}_[0-9]{8}_[0-9]{2}_[A-Z0-9]{5}_[A-Z0-9_\-]{1,10}\.xml$",
+    )
+
+
+class SubRequirement(Enum):
+    """Commodity combination categories."""
+
+    PRIMARY = "PRI"
+    SECONDARY_1 = "SEC1"
+    SECONDARY_2 = "SEC2"
+    TERTIARY_1 = "TER1"
+    PRIMARY_SECONDARY_1 = "PRI-SEC1"
+    PRIMARY_SECONDARY_2 = "PRI-SEC2"
+    PRIMARY_TERTIARY_1 = "PRI-TER1"
+    SECONDARY = "SEC1-SEC2"
+    SECONDARY_1_TERTIARY_1 = "SEC1-TER1"
+    SECONDARY_2_TERTIARY_1 = "SEC2-TER1"
+    PRIAMRY_SECONDARY = "PRI-SEC1-SEC2"
+    PRIMARY_SECONDARY_1_TERTIARY_1 = "PRI-SEC1-TER1"
+    PRIMARY_SECONDARY_2_TERTIARY_1 = "PRI-SEC2-TER1"
+    SECONDARY_TERTIARY_1 = "SEC1-SEC2-TER1"
+    PRIMARY_SECONDARY_TERTIARY_1 = "PRI-SEC1-SEC2-TER1"
+
+
+class ContractSource(Enum):
+    """Describes the source of the contract."""
+
+    MA = "1"
+    SWITCHING = "2"
+
+
+class AwardQuery(Payload, tag="AwardResultsQuery"):
+    """Query object for bid awards."""
+
+    # The market for which results should be retrieved
+    market_type: MarketType = attr(name="MarketType")
+
+    # The area for which results should be retrieved. If this isn't provided, then all results will be retrieved
+    area: Optional[AreaCode] = attr(default=None, name="Area")
+
+    # The associated area. If the API user is a BSP, this field cannot be set
+    linked_area: Optional[AreaCode] = attr(default=None, name="LinkedArea")
+
+    # The name of the resource for which results should be retrieved. If this isn't provided, then all results will be
+    # retrieved for all resources
+    resource: Optional[str] = resource_name("ResourceName", True)
+
+    # The start date and time for which results should be retrieved. Should conform with the start of a block
+    start: DateTime = attr(name="StartTime")
+
+    # The end date and time for which results should be retrieved. Should conform with the end of a block. You can
+    # specify the end date and time of any block within the period from the transaction date to the number of days to
+    # get multiple blocks.
+    end: DateTime = attr(name="EndTime")
+
+    # Whether we are before gate close or after gate close. If this isn't provided, then all results will be retrieved
+    # regardless of gate closure.
+    gate_closed: Optional[BooleanFlag] = attr(default=None, name="AfterGC")
+
+
+class Award(Payload):
+    """Represents the details of a bid award."""
+
+    # Unique identifier assigned to the contract
+    contract_id: str = contract_id("ContractId")
+
+    # Unique identifier assigned to the contract by the JBMS
+    jbms_id: int = jbms_id("JbmsId")
+
+    # The area of the power generation unit generating the electricity
+    area: AreaCode = attr(name="Area")
+
+    # The associated area. If the API user is a BSP, it is not set.
+    linked_area: Optional[AreaCode] = attr(default=None, name="LinkedArea")
+
+    # A code identifying the power generation unit for which this bid was awarded
+    resource: str = resource_name("ResourceName")
+
+    # An abbreviated name for the power generation unit for which this bid was awarded
+    resource_short_name: str = resource_short_name("ResourceShortName")
+
+    # The grid code of the resource being traded
+    system_code: str = system_code("SystemCode")
+
+    # How the power generation unit produces electricity
+    resource_type: ResourceType = attr(name="ResourceType")
+
+    # The type of market for which the offer is being submitted. Must be a valid pattern number for the submission date
+    # Required for VPP resources. Ensure there are no duplicate pattern numbers for the same resource and start time.
+    pattern_number: Optional[int] = dr_patter_number("DrPatternNumber", True)
+
+    # The name of the list pattern with which this award is associated
+    pattern_name: Optional[str] = dr_pattern_name("DrPatternName", True)
+
+    # The participant ID of the BSP associated with this bid award
+    bsp_participant: str = participant("BspParticipantName")
+
+    # The abbreviated name of the counterparty
+    company_short_name: str = company_short_name("CompanyShortName")
+
+    # A code identifying the TSO or MO
+    operator: str = operator_code("OperatorCode")
+
+    # Primary-Secondary 1 command-and-control and monitoring method. Refers to the methodology or system utilized for
+    # regulating and overseeing power generation units' operations in response to external commands or signals. This
+    # method encompasses the process by which instructions are transmitted to power generation units, and their
+    # performance is monitored to ensure compliance with these instructions. If has_secondary_1 is set to True, then
+    # it must be set to DEDICATED_LINE. At least one of the following combinations must be set:
+    #   primary_secondary_1_control_method
+    #   secondary_2_tertiary_control_method
+    primary_secondary_1_control_method: Optional[CommandMonitorMethod] = attr(
+        default=None, name="CommandOperationMethodPriSec1"
+    )
+
+    # Secondary 2-Tertiary command-and-control and monitoring method. Refers to the methodology or system utilized for
+    # regulating and overseeing power generation units' operations in response to external commands or signals. This
+    # method encompasses the process by which instructions are transmitted to power generation units, and their
+    # performance is monitored to ensure compliance with these instructions.
+    secondary_2_tertiary_control_method: Optional[CommandMonitorMethod] = attr(
+        default=None, name="CommandOperationMethodSec2Ter1Ter2"
+    )
+
+    # Bid unit price, in JPY/kW/segment
+    offer_price: Decimal = price("OfferPrice", 10000.00)
+
+    # The contract price, in JPY/kW/segment
+    contract_price: Decimal = price("ContractPrice", 10000.00)
+
+    # The performance evaluation coefficient, alpha
+    performance_evaluation_coefficient: Decimal = attr(name="PerfEvalCoeff", ge=0.00, le=100.0, decimal_places=2)
+
+    # The corrected unit price, in JPY/kW/segment
+    corrected_unit_price: Decimal = price("CorrectedUnitPrice", 1000000.00)
+
+    # The commodity combination category. This is only set for non-BSP users.
+    sub_requirement: Optional[SubRequirement] = attr(default=None, name="SubRequirementType")
+
+    # The primary offer quantity in kW. If the API user is a BSP, this field is not set for the contract results
+    # generated by the TSO's power source exchange.
+    primary_offer_qty: Optional[int] = power_positive("PrimaryOfferQuantityInKw", True)
+
+    # The secondary 1 offer quantity, in kW. If the API user is a BSP, this field is not set for the contract results
+    # generated by the TSO's power source exchange.
+    secondary_1_offer_qty: Optional[int] = power_positive("Secondary1OfferQuantityInKw", True)
+
+    # The secondary 2 offer quantity, in kW. If the API user is a BSP, this field is not set for the contract results
+    # generated by the TSO's power source exchange.
+    secondary_2_offer_qty: Optional[int] = power_positive("Secondary2OfferQuantityInKw", True)
+
+    # The tertiary 1 offer quantity, in kW. If the API user is a BSP, this field is not set for the contract results
+    # generated by the TSO's power source exchange.
+    tertiary_1_offer_qty: Optional[int] = power_positive("Tertiary1OfferQuantityInKw", True)
+
+    # The tertiary 2 offer quantity, in kW. If the API user is a BSP, this field is not set for the contract results
+    # generated by the TSO's power source exchange.
+    tertiary_2_offer_qty: Optional[int] = power_positive("Tertiary2OfferQuantityInKw", True)
+
+    # The primary award quantity, in kW
+    primary_award_qty: Optional[int] = power_positive("PrimaryAwardQuantityInKw", True)
+
+    # The secondary 1 award quantity, in kW
+    secondary_1_award_qty: Optional[int] = power_positive("Secondary1AwardQuantityInKw", True)
+
+    # The secondary 2 award quantity, in kW
+    secondary_2_award_qty: Optional[int] = power_positive("Secondary2AwardQuantityInKw", True)
+
+    # The tertiary 1 award quantity, in kW
+    tertiary_1_award_qty: Optional[int] = power_positive("Tertiary1AwardQuantityInKw", True)
+
+    # The tertiary 2 award quantity, in kW
+    tertiary_2_award_qty: Optional[int] = power_positive("Tertiary2AwardQuantityInKw", True)
+
+    # The primary contract quantity, in kW
+    primary_contract_qty: Optional[int] = power_positive("PrimaryContractQuantityInKw", True)
+
+    # The secondary 1 contract quantity, in kW
+    secondary_1_contract_qty: Optional[int] = power_positive("Secondary1ContractQuantityInKw", True)
+
+    # The secondary 2 contract quantity, in kW
+    secondary_2_contract_qty: Optional[int] = power_positive("Secondary2ContractQuantityInKw", True)
+
+    # The tertiary 1 contract quantity, in kW
+    tertiary_1_contract_qty: Optional[int] = power_positive("Tertiary1ContractQuantityInKw", True)
+
+    # The tertiary 2 contract quantity, in kW
+    tertiary_2_contract_qty: Optional[int] = power_positive("Tertiary2ContractQuantityInKw", True)
+
+    # The primary effective contracted quantity, in kW
+    primary_valid_qty: Optional[int] = power_positive("PrimaryValidQuantityInKw", True)
+
+    # The secondary 1 effective contracted quantity, in kW
+    secondary_1_valid_qty: Optional[int] = power_positive("Secondary1ValidQuantityInKw", True)
+
+    # The secondary 2 effective contracted quantity, in kW
+    secondary_2_valid_qty: Optional[int] = power_positive("Secondary2ValidQuantityInKw", True)
+
+    # The tertiary 1 effective contracted quantity, in kW
+    tertiary_1_valid_qty: Optional[int] = power_positive("Tertiary1ValidQuantityInKw", True)
+
+    # The compound fulfillment quantity, in kW
+    compound_valid_qty: Optional[int] = power_positive("CompoundValidQuantityInKw", True)
+
+    # The primary invalid contract quantity, in kW
+    primary_invalid_qty: Optional[int] = power_positive("PrimaryInvalidQuantityInKw", True)
+
+    # The secondary 1 invalid contract quantity, in kW
+    secondary_1_invalid_qty: Optional[int] = power_positive("Secondary1InvalidQuantityInKw", True)
+
+    # The secondary 2 invalid contract quantity, in kW
+    secondary_2_invalid_qty: Optional[int] = power_positive("Secondary2InvalidQuantityInKw", True)
+
+    # The tertiary 1 invalid contract quantity, in kW
+    tertiary_1_invalid_qty: Optional[int] = power_positive("Tertiary1InvalidQuantityInKw", True)
+
+    # Name of the file containing the negative baseload data
+    negative_baseload_file: Optional[str] = baseload_file_name("BaselineLoadFileNameNeg", True)
+
+    # Name of the file containing the positive baseload data
+    positive_baseload_file: Optional[str] = baseload_file_name("BaselineLoadFileNamePos", True)
+
+    # The date and time when the offer was submitted. If the API user is a BSP, this attribute is not set for the
+    # contract results generated by the TSO's power source exchange.
+    submission_time: Optional[DateTime] = attr(default=None, name="SubmissionTime")
+
+    # Contract result (full, partial)
+    offer_award_level: ContractResult = attr(name="OfferAwardedLevel")
+
+    # The ID of the offer to which this stack belongs
+    offer_id: Optional[str] = offer_id("OfferId", True)
+
+    # The source of the contract
+    contract_source: ContractSource = attr(name="ContractSource")
+
+    # Whether we are before gate close or after gate close
+    gate_closed: BooleanFlag = attr(name="AfterGC")
+
+
+class AwardResult(Payload, tag="AwardResults"):
+    """Contains a number of bid rewards associated with a block of time and trade direction."""
+
+    # The start date and time of the block associated with the awards
+    start: DateTime = attr(name="StartTime")
+
+    # The end date and time of the block associated with the awards
+    end: DateTime = attr(name="EndTime")
+
+    # The direction of the associated trades
+    direction: Direction = attr(name="Direction")
+
+    # The bid awards associated with these parameters
+    data: List[Award] = element(tag="AwardResultsData", min_length=1)
+
+
+class AwardResponse(AwardQuery, tag="AwardResultsQuery"):
+    """Contains the results of a bid award query."""
+
+    # The bid awards associated with the query
+    results: Optional[List[AwardResult]] = wrapped(default=None, path="AwardResultsQueryResponse")

mms_client-1.3.0/src/mms_client/types/enums.py

@@ -0,0 +1,73 @@
+"""Contains enums common to all MMS types."""
+
+from enum import Enum
+from enum import IntEnum
+
+
+class AreaCode(Enum):
+    """Represents the area code of the market."""
+
+    HOKKAIDO = "01"
+    TOHOKU = "02"
+    TOKYO = "03"
+    CHUBU = "04"
+    HOKURIKU = "05"
+    KANSAI = "06"
+    CHUGOKU = "07"
+    SHIKOKU = "08"
+    KYUSHU = "09"
+    OKINAWA = "10"
+
+
+class Direction(Enum):
+    """Represents the reserve direction of the offer."""
+
+    SELL = "1"  # Increasing the reserves (sell)
+    # Note: Support for the BUY direction was removed from the MMS API
+    # BUY = "2"  # Decreasing the reserves (buy)
+
+
+class ContractResult(Enum):
+    """Represents the result of a contract."""
+
+    FULL = "1"
+    PARTIAL = "2"
+
+
+class Frequency(IntEnum):
+    """Represents the frequency of power sources."""
+
+    EAST = 50
+    WEST = 60
+
+
+class ResourceType(Enum):
+    """How the power generation unit produces electricity."""
+
+    THERMAL = "01"
+    HYDRO = "02"
+    PUMP = "03"
+    BATTERY = "04"
+    VPP_GEN = "05"
+    VPP_GEN_AND_DEM = "06"
+    VPP_DEM = "07"
+
+
+class CommandMonitorMethod(Enum):
+    """Describes how the power generation unit is monitored and commanded."""
+
+    DEDICATED_LINE = "1"
+    SIMPLE_COMMAND = "2"
+    OFFLINE = "3"
+
+
+class BooleanFlag(Enum):
+    """Represents a Boolean value as an enumeration.
+
+    There are many places throughout the MMS documenation where Boolean values are treated as enums for reasons that are
+    not clear. This is a common pattern and this class is provided to make it easier to handle these cases without
+    having many different enum classes
+    """
+
+    YES = "1"
+    NO = "0"