EPA-PM-API-Wrapper 0.3.0__py3-none-any.whl

epa_pm_api_wrapper/models/meter_type.py

@@ -0,0 +1,131 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from xsdata.models.datatype import XmlDate
+
+from .log_type import LogType
+from .meter_type_unit_of_measure import MeterTypeUnitOfMeasure
+from .share_level_type import ShareLevelType
+from .type_of_meter import TypeOfMeter
+
+
+@dataclass(kw_only=True)
+class MeterType:
+    """
+    A service type used for representing a meter.
+
+    :ivar id: The id of the meter.
+    :ivar type_value: The type of meter (i.e. electric, natural gas,
+        PDU, Indoor, etc.).
+    :ivar name: The name of the meter.
+    :ivar metered: Indicates if the meter is set up to be metered
+        monthly or for bulk delivery.
+    :ivar unit_of_measure: The units that measure the energy for the
+        meter (Kbtu, KWh, Mbtu, MWh, ccf, gallons, etc.).
+    :ivar first_bill_date: The date of the first bill.
+    :ivar in_use: Is this meter in use?
+    :ivar inactive_date: If the meter is no longer in use, this is the
+        date that it went inactive.
+    :ivar other_description: If the type of meter is "Other," this is
+        the description of the meter's energy type.
+    :ivar access_level: Current share level for the user calling the
+        webservice.
+    :ivar aggregate_meter: If the meter is aggregate meter or not.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "meterType"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    type_value: TypeOfMeter = field(
+        metadata={
+            "name": "type",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 100,
+        }
+    )
+    metered: None | bool = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    unit_of_measure: MeterTypeUnitOfMeasure = field(
+        metadata={
+            "name": "unitOfMeasure",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    first_bill_date: XmlDate = field(
+        metadata={
+            "name": "firstBillDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    in_use: bool = field(
+        metadata={
+            "name": "inUse",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    inactive_date: None | XmlDate = field(
+        default=None,
+        metadata={
+            "name": "inactiveDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    other_description: None | str = field(
+        default=None,
+        metadata={
+            "name": "otherDescription",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 100,
+        },
+    )
+    access_level: None | ShareLevelType = field(
+        default=None,
+        metadata={
+            "name": "accessLevel",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    aggregate_meter: None | bool = field(
+        default=None,
+        metadata={
+            "name": "aggregateMeter",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/meter_type_unit_of_measure.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class MeterTypeUnitOfMeasure(Enum):
+    CCF_HUNDRED_CUBIC_FEET = "ccf (hundred cubic feet)"
+    CF_CUBIC_FEET = "cf (cubic feet)"
+    C_GAL_HUNDRED_GALLONS_UK = "cGal (hundred gallons) (UK)"
+    C_GAL_HUNDRED_GALLONS_US = "cGal (hundred gallons) (US)"
+    CUBIC_METERS_PER_DAY = "Cubic Meters per Day"
+    CM_CUBIC_METERS = "cm (Cubic meters)"
+    CORDS = "Cords"
+    E_KWH_EQUIVALENT_KILOWATT_HOUR = "eKWh (Equivalent Kilowatt hour)"
+    GALLONS_UK = "Gallons (UK)"
+    GALLONS_US = "Gallons (US)"
+    GJ = "GJ"
+    K_BTU_THOUSAND_BTU = "kBtu (thousand Btu)"
+    KCF_THOUSAND_CUBIC_FEET = "kcf (thousand cubic feet)"
+    KCM_THOUSAND_CUBIC_METERS = "Kcm (Thousand Cubic meters)"
+    KGAL_THOUSAND_GALLONS_UK = "KGal (thousand gallons) (UK)"
+    KGAL_THOUSAND_GALLONS_US = "KGal (thousand gallons) (US)"
+    KILOGRAM = "Kilogram"
+    KLBS_THOUSAND_POUNDS = "KLbs. (thousand pounds)"
+    K_WH_THOUSAND_WATT_HOURS = "kWh (thousand Watt-hours)"
+    LITERS = "Liters"
+    MBTU_MILLION_BTU = "MBtu (million Btu)"
+    MCF_MILLION_CUBIC_FEET = "MCF(million cubic feet)"
+    MG_L_MILLIGRAMS_PER_LITER = "mg/l (milligrams per liter)"
+    MGAL_MILLION_GALLONS_UK = "MGal (million gallons) (UK)"
+    MGAL_MILLION_GALLONS_US = "MGal (million gallons) (US)"
+    MILLION_GALLONS_PER_DAY = "Million Gallons per Day"
+    MLBS_MILLION_POUNDS = "MLbs. (million pounds)"
+    MWH_MILLION_WATT_HOURS = "MWh (million Watt-hours)"
+    POUNDS = "pounds"
+    POUNDS_PER_YEAR = "Pounds per year"
+    THERMS = "therms"
+    TON_HOURS = "ton hours"
+    TONNES_METRIC = "Tonnes (metric)"
+    TONS = "tons"

epa_pm_api_wrapper/models/metric.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .data_type import DataType
+from .report_metric_values_ws import ReportMetricValuesWs
+
+
+@dataclass(kw_only=True)
+class Metric:
+    """
+    :ivar monthly_metric: The value of the Monthly metric.
+    :ivar value: The value of the Non-Monthly metric.
+    :ivar name: The name of the metric.
+    :ivar id: The id of the metric.
+    :ivar uom: The unit of measure of the metric.
+    :ivar data_type: The data type of the value for the metric (i.e.,
+        string, numeric, date).
+    :ivar auto_generated: Indicates whether the metric is automatically
+        generated by the system.
+    """
+
+    class Meta:
+        name = "metric"
+
+    monthly_metric: list[ReportMetricValuesWs] = field(
+        default_factory=list,
+        metadata={
+            "name": "monthlyMetric",
+            "type": "Element",
+        },
+    )
+    value: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "nillable": True,
+        },
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    uom: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    data_type: None | DataType = field(
+        default=None,
+        metadata={
+            "name": "dataType",
+            "type": "Attribute",
+        },
+    )
+    auto_generated: None | bool = field(
+        default=None,
+        metadata={
+            "name": "autoGenerated",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/months_in_use.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .months_in_use_type import MonthsInUseType
+
+
+@dataclass(kw_only=True)
+class MonthsInUse(MonthsInUseType):
+    """
+    Number of months per year the property is in use.
+    """
+
+    class Meta:
+        name = "monthsInUse"

epa_pm_api_wrapper/models/months_in_use_type.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .use_attribute_base import UseAttributeBase
+
+
+@dataclass(kw_only=True)
+class MonthsInUseType(UseAttributeBase):
+    class Meta:
+        name = "monthsInUseType"
+
+    value: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_inclusive": 1,
+            "max_inclusive": 12,
+        },
+    )

epa_pm_api_wrapper/models/months_main_indoor_ice_rink_in_use.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .months_in_use_type import MonthsInUseType
+
+
+@dataclass(kw_only=True)
+class MonthsMainIndoorIceRinkInUse(MonthsInUseType):
+    """
+    Number of months per year the property is in use.
+    """
+
+    class Meta:
+        name = "monthsMainIndoorIceRinkInUse"

epa_pm_api_wrapper/models/months_school_in_use_type.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .use_attribute_base import UseAttributeBase
+
+
+@dataclass(kw_only=True)
+class MonthsSchoolInUseType(UseAttributeBase):
+    class Meta:
+        name = "monthsSchoolInUseType"
+
+    value: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_inclusive": 8,
+            "max_inclusive": 12,
+        },
+    )

epa_pm_api_wrapper/models/movie_theater.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class MovieTheater(OtherType):
+    """
+    Buildings used for public or private film screenings.
+    """
+
+    class Meta:
+        name = "movieTheater"

epa_pm_api_wrapper/models/multifamily_housing.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .multifamily_housing_type import MultifamilyHousingType
+
+
+@dataclass(kw_only=True)
+class MultifamilyHousing(MultifamilyHousingType):
+    """
+    Residential Buildings that contain more than two residential living
+    units.
+    """
+
+    class Meta:
+        name = "multifamilyHousing"

epa_pm_api_wrapper/models/multifamily_housing_type.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .log_type import LogType
+from .multifamily_housing_type_use_details import (
+    MultifamilyHousingTypeUseDetails,
+)
+
+
+@dataclass(kw_only=True)
+class MultifamilyHousingType:
+    class Meta:
+        name = "multifamilyHousingType"
+
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        }
+    )
+    use_details: MultifamilyHousingTypeUseDetails = field(
+        metadata={
+            "name": "useDetails",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/multifamily_housing_type_use_details.py

@@ -0,0 +1,124 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .common_entrance import CommonEntrance
+from .government_subsidized_housing import GovernmentSubsidizedHousing
+from .number_of_bedrooms import NumberOfBedrooms
+from .number_of_laundry_hookups_in_all_units import (
+    NumberOfLaundryHookupsInAllUnits,
+)
+from .number_of_laundry_hookups_in_common_area import (
+    NumberOfLaundryHookupsInCommonArea,
+)
+from .number_of_residential_living_units import NumberOfResidentialLivingUnits
+from .number_of_residential_living_units_high_rise_setting import (
+    NumberOfResidentialLivingUnitsHighRiseSetting,
+)
+from .number_of_residential_living_units_low_rise_setting import (
+    NumberOfResidentialLivingUnitsLowRiseSetting,
+)
+from .number_of_residential_living_units_mid_rise_setting import (
+    NumberOfResidentialLivingUnitsMidRiseSetting,
+)
+from .percent_cooled import PercentCooled
+from .percent_heated import PercentHeated
+from .resident_population import ResidentPopulation
+from .total_gross_floor_area import TotalGrossFloorArea
+
+
+@dataclass(kw_only=True)
+class MultifamilyHousingTypeUseDetails:
+    class Meta:
+        global_type = False
+
+    total_gross_floor_area: TotalGrossFloorArea = field(
+        metadata={
+            "name": "totalGrossFloorArea",
+            "type": "Element",
+        }
+    )
+    number_of_residential_living_units: None | NumberOfResidentialLivingUnits = field(
+        default=None,
+        metadata={
+            "name": "numberOfResidentialLivingUnits",
+            "type": "Element",
+        },
+    )
+    number_of_bedrooms: None | NumberOfBedrooms = field(
+        default=None,
+        metadata={
+            "name": "numberOfBedrooms",
+            "type": "Element",
+        },
+    )
+    number_of_residential_living_units_mid_rise_setting: None | NumberOfResidentialLivingUnitsMidRiseSetting = field(
+        default=None,
+        metadata={
+            "name": "numberOfResidentialLivingUnitsMidRiseSetting",
+            "type": "Element",
+        },
+    )
+    number_of_laundry_hookups_in_all_units: None | NumberOfLaundryHookupsInAllUnits = field(
+        default=None,
+        metadata={
+            "name": "numberOfLaundryHookupsInAllUnits",
+            "type": "Element",
+        },
+    )
+    number_of_laundry_hookups_in_common_area: None | NumberOfLaundryHookupsInCommonArea = field(
+        default=None,
+        metadata={
+            "name": "numberOfLaundryHookupsInCommonArea",
+            "type": "Element",
+        },
+    )
+    number_of_residential_living_units_low_rise_setting: None | NumberOfResidentialLivingUnitsLowRiseSetting = field(
+        default=None,
+        metadata={
+            "name": "numberOfResidentialLivingUnitsLowRiseSetting",
+            "type": "Element",
+        },
+    )
+    percent_heated: None | PercentHeated = field(
+        default=None,
+        metadata={
+            "name": "percentHeated",
+            "type": "Element",
+        },
+    )
+    percent_cooled: None | PercentCooled = field(
+        default=None,
+        metadata={
+            "name": "percentCooled",
+            "type": "Element",
+        },
+    )
+    number_of_residential_living_units_high_rise_setting: None | NumberOfResidentialLivingUnitsHighRiseSetting = field(
+        default=None,
+        metadata={
+            "name": "numberOfResidentialLivingUnitsHighRiseSetting",
+            "type": "Element",
+        },
+    )
+    resident_population: None | ResidentPopulation = field(
+        default=None,
+        metadata={
+            "name": "residentPopulation",
+            "type": "Element",
+        },
+    )
+    government_subsidized_housing: None | GovernmentSubsidizedHousing = field(
+        default=None,
+        metadata={
+            "name": "governmentSubsidizedHousing",
+            "type": "Element",
+        },
+    )
+    common_entrance: None | CommonEntrance = field(
+        default=None,
+        metadata={
+            "name": "commonEntrance",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/museum.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .museum_type import MuseumType
+
+
+@dataclass(kw_only=True)
+class Museum(MuseumType):
+    """
+    Museum refers to buildings that display collections to outside visitors
+    for public viewing and enjoyment and for informational/educational
+    purposes. <br xmlns=""/> <br xmlns=""/> Gross Floor Area should
+    include all space within the building(s), including but not limited to
+    public collection display areas, meeting rooms, restrooms, classrooms,
+    gift shops, food service areas, administrative/office space, mechanical
+    rooms, storage areas for collections, libraries, elevator shafts,
+    stairwells, and movie theatre space inside the museum.
+
+    Areas not in enclosed building such as outdoor exhibit, open-air
+    theaters, walkways, and landscaped areas should not be included in the
+    Gross Floor Area.
+    """
+
+    class Meta:
+        name = "museum"

epa_pm_api_wrapper/models/museum_type.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .log_type import LogType
+from .museum_type_use_details import MuseumTypeUseDetails
+
+
+@dataclass(kw_only=True)
+class MuseumType:
+    class Meta:
+        name = "museumType"
+
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        }
+    )
+    use_details: MuseumTypeUseDetails = field(
+        metadata={
+            "name": "useDetails",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/museum_type_use_details.py

@@ -0,0 +1,78 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .gross_floor_area_that_is_exhibit_space import (
+    GrossFloorAreaThatIsExhibitSpace,
+)
+from .number_of_computers import NumberOfComputers
+from .number_of_workers import NumberOfWorkers
+from .percent_cooled import PercentCooled
+from .percent_heated import PercentHeated
+from .precision_controls_for_temperature_and_humidity import (
+    PrecisionControlsForTemperatureAndHumidity,
+)
+from .total_gross_floor_area import TotalGrossFloorArea
+from .weekly_operating_hours import WeeklyOperatingHours
+
+
+@dataclass(kw_only=True)
+class MuseumTypeUseDetails:
+    class Meta:
+        global_type = False
+
+    total_gross_floor_area: TotalGrossFloorArea = field(
+        metadata={
+            "name": "totalGrossFloorArea",
+            "type": "Element",
+        }
+    )
+    number_of_workers: None | NumberOfWorkers = field(
+        default=None,
+        metadata={
+            "name": "numberOfWorkers",
+            "type": "Element",
+        },
+    )
+    precision_controls_for_temperature_and_humidity: None | PrecisionControlsForTemperatureAndHumidity = field(
+        default=None,
+        metadata={
+            "name": "precisionControlsForTemperatureAndHumidity",
+            "type": "Element",
+        },
+    )
+    gross_floor_area_that_is_exhibit_space: None | GrossFloorAreaThatIsExhibitSpace = field(
+        default=None,
+        metadata={
+            "name": "grossFloorAreaThatIsExhibitSpace",
+            "type": "Element",
+        },
+    )
+    percent_heated: None | PercentHeated = field(
+        default=None,
+        metadata={
+            "name": "percentHeated",
+            "type": "Element",
+        },
+    )
+    percent_cooled: None | PercentCooled = field(
+        default=None,
+        metadata={
+            "name": "percentCooled",
+            "type": "Element",
+        },
+    )
+    number_of_computers: None | NumberOfComputers = field(
+        default=None,
+        metadata={
+            "name": "numberOfComputers",
+            "type": "Element",
+        },
+    )
+    weekly_operating_hours: None | WeeklyOperatingHours = field(
+        default=None,
+        metadata={
+            "name": "weeklyOperatingHours",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/non_refrigerated_warehouse.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .non_refrigerated_warehouse_type import NonRefrigeratedWarehouseType
+
+
+@dataclass(kw_only=True)
+class NonRefrigeratedWarehouse(NonRefrigeratedWarehouseType):
+    """
+    Unrefrigerated Buildings that are used to store goods, manufactured
+    products, merchandise or raw materials.
+    """
+
+    class Meta:
+        name = "nonRefrigeratedWarehouse"