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

epa_pm_api_wrapper/models/timeframe_type.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .timeframe_type_baseline_period import TimeframeTypeBaselinePeriod
+from .timeframe_type_compare_baseline_period import (
+    TimeframeTypeCompareBaselinePeriod,
+)
+from .timeframe_type_compare_current_period import (
+    TimeframeTypeCompareCurrentPeriod,
+)
+from .timeframe_type_current_period import TimeframeTypeCurrentPeriod
+from .timeframe_type_current_vs_baseline import TimeframeTypeCurrentVsBaseline
+from .timeframe_type_date_range import TimeframeTypeDateRange
+from .timeframe_type_single_period import TimeframeTypeSinglePeriod
+from .timeframe_type_two_periods import TimeframeTypeTwoPeriods
+
+
+@dataclass(kw_only=True)
+class TimeframeType:
+    """
+    :ivar current_period: Returns metrics for the most recent year in
+        which each of your properties has a full year of data for the
+        selected meter type (energy/water/waste). This can be a
+        different year for each property.
+    :ivar baseline_period: Returns metrics for the baseline period that
+        you set on the "Goals" tab for each individual property. You can
+        have different baselines for different meter types
+        (energy/water/waste).
+    :ivar current_vs_baseline: Returns metrics for each property's
+        current year and its baseline year.
+    :ivar single_period: Returns metrics for a specific year that you
+        specify.
+    :ivar compare_current_period: Returns metrics for each property's
+        current year and another year which you specify.
+    :ivar compare_baseline_period: Returns metrics for each property's
+        baseline period and another year which you specify.
+    :ivar two_periods: Returns metrics for each property in two specific
+        years that you select.
+    :ivar date_range: Returns metrics for each property on a monthly,
+        quarterly, or annual interval between a start and end date that
+        you specify.
+    """
+
+    class Meta:
+        name = "timeframeType"
+
+    current_period: None | TimeframeTypeCurrentPeriod = field(
+        default=None,
+        metadata={
+            "name": "currentPeriod",
+            "type": "Element",
+        },
+    )
+    baseline_period: None | TimeframeTypeBaselinePeriod = field(
+        default=None,
+        metadata={
+            "name": "baselinePeriod",
+            "type": "Element",
+        },
+    )
+    current_vs_baseline: None | TimeframeTypeCurrentVsBaseline = field(
+        default=None,
+        metadata={
+            "name": "currentVsBaseline",
+            "type": "Element",
+        },
+    )
+    single_period: None | TimeframeTypeSinglePeriod = field(
+        default=None,
+        metadata={
+            "name": "singlePeriod",
+            "type": "Element",
+        },
+    )
+    compare_current_period: None | TimeframeTypeCompareCurrentPeriod = field(
+        default=None,
+        metadata={
+            "name": "compareCurrentPeriod",
+            "type": "Element",
+        },
+    )
+    compare_baseline_period: None | TimeframeTypeCompareBaselinePeriod = field(
+        default=None,
+        metadata={
+            "name": "compareBaselinePeriod",
+            "type": "Element",
+        },
+    )
+    two_periods: None | TimeframeTypeTwoPeriods = field(
+        default=None,
+        metadata={
+            "name": "twoPeriods",
+            "type": "Element",
+        },
+    )
+    date_range: None | TimeframeTypeDateRange = field(
+        default=None,
+        metadata={
+            "name": "dateRange",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/timeframe_type_baseline_period.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .meter_category_type import MeterCategoryType
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeBaselinePeriod:
+    class Meta:
+        global_type = False
+
+    meter_type: MeterCategoryType = field(
+        metadata={
+            "name": "meterType",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_compare_baseline_period.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .meter_category_type import MeterCategoryType
+from .ped import Ped
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeCompareBaselinePeriod:
+    class Meta:
+        global_type = False
+
+    meter_type: MeterCategoryType = field(
+        metadata={
+            "name": "meterType",
+            "type": "Element",
+        }
+    )
+    period_ending_date: Ped = field(
+        metadata={
+            "name": "periodEndingDate",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_compare_current_period.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .meter_category_type import MeterCategoryType
+from .ped import Ped
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeCompareCurrentPeriod:
+    class Meta:
+        global_type = False
+
+    meter_type: MeterCategoryType = field(
+        metadata={
+            "name": "meterType",
+            "type": "Element",
+        }
+    )
+    period_ending_date: Ped = field(
+        metadata={
+            "name": "periodEndingDate",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_current_period.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .meter_category_type import MeterCategoryType
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeCurrentPeriod:
+    class Meta:
+        global_type = False
+
+    meter_type: MeterCategoryType = field(
+        metadata={
+            "name": "meterType",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_current_vs_baseline.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .meter_category_type import MeterCategoryType
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeCurrentVsBaseline:
+    class Meta:
+        global_type = False
+
+    meter_type: MeterCategoryType = field(
+        metadata={
+            "name": "meterType",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_date_range.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .ped import Ped
+from .reporting_interval_type import ReportingIntervalType
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeDateRange:
+    class Meta:
+        global_type = False
+
+    from_period_ending_date: Ped = field(
+        metadata={
+            "name": "fromPeriodEndingDate",
+            "type": "Element",
+        }
+    )
+    to_period_ending_date: Ped = field(
+        metadata={
+            "name": "toPeriodEndingDate",
+            "type": "Element",
+        }
+    )
+    interval: ReportingIntervalType = field(
+        metadata={
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_single_period.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .ped import Ped
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeSinglePeriod:
+    class Meta:
+        global_type = False
+
+    period_ending_date: Ped = field(
+        metadata={
+            "name": "periodEndingDate",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/timeframe_type_two_periods.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .ped import Ped
+
+
+@dataclass(kw_only=True)
+class TimeframeTypeTwoPeriods:
+    class Meta:
+        global_type = False
+
+    period_ending_date_one: Ped = field(
+        metadata={
+            "name": "periodEndingDateOne",
+            "type": "Element",
+        }
+    )
+    period_ending_date_two: Ped = field(
+        metadata={
+            "name": "periodEndingDateTwo",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/total_gross_floor_area.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .gross_floor_area_type import GrossFloorAreaType
+
+
+@dataclass(kw_only=True)
+class TotalGrossFloorArea(GrossFloorAreaType):
+    class Meta:
+        name = "totalGrossFloorArea"

epa_pm_api_wrapper/models/total_ice_rink_surface_area_for_all_rinks.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .optional_floor_area_type import OptionalFloorAreaType
+
+
+@dataclass(kw_only=True)
+class TotalIceRinkSurfaceAreaForAllRinks(OptionalFloorAreaType):
+    """
+    The indoor ice rink surface area is the total area covered by ice of
+    all the ice rinks used for indoor hockey, ringette, public or figure
+    skating and can be estimated by multiplying the length of the ice
+    surface with the width of the ice surface and adding together the
+    calculated area for each ice rink in the facility.
+
+    This surface area does not include curling sheets.
+    """
+
+    class Meta:
+        name = "totalIceRinkSurfaceAreaForAllRinks"

epa_pm_api_wrapper/models/transportation_terminal_station.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class TransportationTerminalStation(OtherType):
+    """
+    Buildings used primarily for accessing public or private
+    transportation.
+    """
+
+    class Meta:
+        name = "transportationTerminalStation"

epa_pm_api_wrapper/models/type_of_energy_star_partner.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TypeOfEnergyStarPartner(Enum):
+    ASSOCIATIONS = "Associations"
+    ORGANIZATIONS_THAT_OWN_MANAGE_LEASE_BUILDINGS_AND_PLANTS = (
+        "Organizations that Own/Manage/Lease Buildings and Plants"
+    )
+    SERVICE_AND_PRODUCT_PROVIDERS = "Service and Product Providers"
+    SMALL_BUSINESSES = "Small Businesses"
+    UTILITIES_AND_ENERGY_EFFICIENCY_PROGRAM_SPONSORS = "Utilities and Energy Efficiency Program Sponsors"
+    OTHER = "Other"

epa_pm_api_wrapper/models/type_of_meter.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TypeOfMeter(Enum):
+    COAL_ANTHRACITE = "Coal Anthracite"
+    COAL_BITUMINOUS = "Coal Bituminous"
+    COKE = "Coke"
+    DIESEL = "Diesel"
+    DISTRICT_CHILLED_WATER_ABSORPTION_CHILLER_USING_NATURAL_GAS = (
+        "District Chilled Water - Absorption Chiller using Natural Gas"
+    )
+    DISTRICT_CHILLED_WATER_ELECTRIC_DRIVEN_CHILLER = "District Chilled Water - Electric-Driven Chiller"
+    DISTRICT_CHILLED_WATER_ENGINE_DRIVEN_CHILLER_USING_NATURAL_GAS = (
+        "District Chilled Water - Engine-Driven Chiller using Natural Gas"
+    )
+    DISTRICT_CHILLED_WATER_OTHER = "District Chilled Water - Other"
+    DISTRICT_HOT_WATER = "District Hot Water"
+    DISTRICT_STEAM = "District Steam"
+    ELECTRIC = "Electric"
+    ELECTRIC_ON_SITE_SOLAR = "Electric on Site Solar"
+    ELECTRIC_ON_SITE_WIND = "Electric on Site Wind"
+    FUEL_OIL_NO_1 = "Fuel Oil No 1"
+    FUEL_OIL_NO_2 = "Fuel Oil No 2"
+    FUEL_OIL_NO_4 = "Fuel Oil No 4"
+    FUEL_OIL_NO_5_OR_6 = "Fuel Oil No 5 or 6"
+    KEROSENE = "Kerosene"
+    NATURAL_GAS = "Natural Gas"
+    OTHER_ENERGY = "Other (Energy)"
+    PROPANE = "Propane"
+    WOOD = "Wood"
+    IT_EQUIPMENT_INPUT_ENERGY_METERS_ON_EACH_PIECE_OF_EQUIPMENT = (
+        "IT Equipment Input Energy (meters on each piece of equipment)"
+    )
+    POWER_DISTRIBUTION_UNIT_PDU_INPUT_ENERGY = "Power Distribution Unit (PDU) Input Energy"
+    POWER_DISTRIBUTION_UNIT_PDU_OUTPUT_ENERGY = "Power Distribution Unit (PDU) Output Energy"
+    UNINTERRUPTIBLE_POWER_SUPPLY_UPS_OUTPUT_ENERGY = "Uninterruptible Power Supply (UPS) Output Energy"
+    MUNICIPALLY_SUPPLIED_POTABLE_WATER_MIXED_INDOOR_OUTDOOR = (
+        "Municipally Supplied Potable Water - Mixed Indoor/Outdoor"
+    )
+    MUNICIPALLY_SUPPLIED_POTABLE_WATER_INDOOR = "Municipally Supplied Potable Water - Indoor"
+    MUNICIPALLY_SUPPLIED_POTABLE_WATER_OUTDOOR = "Municipally Supplied Potable Water - Outdoor"
+    MUNICIPALLY_SUPPLIED_RECLAIMED_WATER_MIXED_INDOOR_OUTDOOR = (
+        "Municipally Supplied Reclaimed Water - Mixed Indoor/Outdoor"
+    )
+    MUNICIPALLY_SUPPLIED_RECLAIMED_WATER_INDOOR = "Municipally Supplied Reclaimed Water - Indoor"
+    MUNICIPALLY_SUPPLIED_RECLAIMED_WATER_OUTDOOR = "Municipally Supplied Reclaimed Water - Outdoor"
+    OTHER_MIXED_INDOOR_OUTDOOR_WATER = "Other - Mixed Indoor/Outdoor (Water)"
+    OTHER_OUTDOOR = "Other - Outdoor"
+    OTHER_INDOOR = "Other - Indoor"
+    AVERAGE_INFLUENT_FLOW = "Average Influent Flow"
+    WELL_WATER_MIXED_INDOOR_OUTDOOR = "Well Water - Mixed Indoor/Outdoor"
+    WELL_WATER_INDOOR = "Well Water - Indoor"
+    WELL_WATER_OUTDOOR = "Well Water - Outdoor"

epa_pm_api_wrapper/models/type_of_waste_meter.py

@@ -0,0 +1,122 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from xsdata.models.datatype import XmlDate
+
+from .log_type import LogType
+from .share_level_type import ShareLevelType
+from .type_of_waste_meter_data_entry_method import (
+    TypeOfWasteMeterDataEntryMethod,
+)
+from .type_of_waste_meter_unit_of_measure import TypeOfWasteMeterUnitOfMeasure
+from .waste_meter_type import WasteMeterType
+
+
+@dataclass(kw_only=True)
+class TypeOfWasteMeter:
+    """
+    :ivar id: The id of the waste meter.
+    :ivar name: The name of the waste meter.
+    :ivar type_value: The type of waste meter.
+    :ivar unit_of_measure: The units that measure the waste quantity for
+        the meter.
+    :ivar data_entry_method: The format of meter data entries.
+    :ivar container_size: The size of the container.
+    :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 access_level: Current share level for the user calling the
+        webservice.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "typeOfWasteMeter"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 100,
+        }
+    )
+    type_value: WasteMeterType = field(
+        metadata={
+            "name": "type",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    unit_of_measure: TypeOfWasteMeterUnitOfMeasure = field(
+        metadata={
+            "name": "unitOfMeasure",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    data_entry_method: TypeOfWasteMeterDataEntryMethod = field(
+        metadata={
+            "name": "dataEntryMethod",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    container_size: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "containerSize",
+            "type": "Element",
+            "namespace": "",
+            "min_inclusive": Decimal("0"),
+            "fraction_digits": 2,
+        },
+    )
+    first_bill_date: None | XmlDate = field(
+        default=None,
+        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": "",
+        },
+    )
+    access_level: None | ShareLevelType = field(
+        default=None,
+        metadata={
+            "name": "accessLevel",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/type_of_waste_meter_data_entry_method.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TypeOfWasteMeterDataEntryMethod(Enum):
+    """
+    :cvar REGULAR: Indicates that you know the weight or volume of the
+        waste/material.
+    :cvar REGULAR_CONTAINER: Indicates that you know the size of the
+        bin/dumpster.
+    :cvar INTERMITTENT: Indicates that the waste/material is collected
+        intermittently or one-time only.
+    """
+
+    REGULAR = "regular"
+    REGULAR_CONTAINER = "regular container"
+    INTERMITTENT = "intermittent"

epa_pm_api_wrapper/models/type_of_waste_meter_unit_of_measure.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class TypeOfWasteMeterUnitOfMeasure(Enum):
+    POUNDS = "pounds"
+    KILOGRAM = "Kilogram"
+    TONS = "tons"
+    TONNES_METRIC = "Tonnes (metric)"
+    CUBIC_YARDS = "Cubic yards"
+    CM_CUBIC_METERS = "cm (Cubic meters)"
+    GALLONS_US = "Gallons (US)"
+    GALLONS_UK = "Gallons (UK)"
+    LITERS = "Liters"

epa_pm_api_wrapper/models/un_auth_design_type.py

@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from .property_design_type import PropertyDesignType
+from .un_auth_design_type_estimated_energy_list import (
+    UnAuthDesignTypeEstimatedEnergyList,
+)
+from .un_auth_design_type_property_uses import UnAuthDesignTypePropertyUses
+from .un_auth_design_type_target import UnAuthDesignTypeTarget
+
+
+@dataclass(kw_only=True)
+class UnAuthDesignType:
+    """
+    :ivar property_info:
+    :ivar property_uses: Most property use characteristics XML
+        attributes (id, currentAsOf, and temporary) are not applicable
+        and will be ignored if provided.
+    :ivar drinking_water_influent_flow: The planned average daily flow
+        for a Water Treatment and Distribution Plant.  This value must
+        be specified if one of the property uses is of the type Water
+        Distribution.
+    :ivar waste_water_influent_flow: The planned average daily flow of
+        water through a Wastewater Treatment Plant.  This value must be
+        specified if one of the property uses is of the type Waste Water
+        Treatment Plant.
+    :ivar it_site_energy: The amount of energy required by the server
+        racks, storage silos, and other IT equipment in the Data Center
+        at the output of UPS.  This value must be specified if one of
+        the property uses is of the type Data Center
+    :ivar estimated_energy_list: If you can estimate how much energy
+        your design property will use annually, provide it here to
+        receive a score (if available) and energy metrics for your
+        design.  You can then use these metrics to compare to your
+        target and/or property's operation (in the future).  To get the
+        most accurate metrics, provide estimates for total annual energy
+        from each potential energy source.
+    :ivar target: The Design Target can be either ENERGY STAR Score or
+        "% Better than Median."
+    :ivar international_weather_station_id: The WMO id of the
+        international weather station.
+    """
+
+    class Meta:
+        name = "unAuthDesignType"
+
+    property_info: PropertyDesignType = field(
+        metadata={
+            "name": "propertyInfo",
+            "type": "Element",
+        }
+    )
+    property_uses: UnAuthDesignTypePropertyUses = field(
+        metadata={
+            "name": "propertyUses",
+            "type": "Element",
+        }
+    )
+    drinking_water_influent_flow: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "drinkingWaterInfluentFlow",
+            "type": "Element",
+        },
+    )
+    waste_water_influent_flow: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "wasteWaterInfluentFlow",
+            "type": "Element",
+        },
+    )
+    it_site_energy: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "itSiteEnergy",
+            "type": "Element",
+        },
+    )
+    estimated_energy_list: None | UnAuthDesignTypeEstimatedEnergyList = field(
+        default=None,
+        metadata={
+            "name": "estimatedEnergyList",
+            "type": "Element",
+        },
+    )
+    target: UnAuthDesignTypeTarget = field(
+        metadata={
+            "type": "Element",
+        }
+    )
+    international_weather_station_id: None | str = field(
+        default=None,
+        metadata={
+            "name": "internationalWeatherStationId",
+            "type": "Element",
+        },
+    )