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

epa_pm_api_wrapper/models/property_design_type.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .address_type import AddressType
+from .gross_floor_area_type import GrossFloorAreaType
+from .primary_function_type import PrimaryFunctionType
+
+
+@dataclass(kw_only=True)
+class PropertyDesignType:
+    """
+    :ivar name: The name of the property.
+    :ivar primary_function: The primary function of the property.
+    :ivar gross_floor_area: The Gross Floor Area of the property.  The
+        id, currentAsOf, and temporary XML attributes are not applicable
+        and will be ignored if provided. It is not needed by Target
+        Finder.
+    :ivar planned_construction_completion_year: The year planned for
+        construction completion.
+    :ivar address:
+    :ivar number_of_buildings: The estimated number of buildings for
+        this property.  Please note that this is only for informational
+        purposes.
+    """
+
+    class Meta:
+        name = "propertyDesignType"
+
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "min_length": 1,
+            "max_length": 80,
+        }
+    )
+    primary_function: PrimaryFunctionType = field(
+        metadata={
+            "name": "primaryFunction",
+            "type": "Element",
+        }
+    )
+    gross_floor_area: GrossFloorAreaType = field(
+        metadata={
+            "name": "grossFloorArea",
+            "type": "Element",
+        }
+    )
+    planned_construction_completion_year: int = field(
+        metadata={
+            "name": "plannedConstructionCompletionYear",
+            "type": "Element",
+        }
+    )
+    address: AddressType = field(
+        metadata={
+            "type": "Element",
+        }
+    )
+    number_of_buildings: int = field(
+        metadata={
+            "name": "numberOfBuildings",
+            "type": "Element",
+            "min_inclusive": 0,
+        }
+    )

epa_pm_api_wrapper/models/property_metrics.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .property_metrics_type import PropertyMetricsType
+
+
+@dataclass(kw_only=True)
+class PropertyMetrics(PropertyMetricsType):
+    """
+    All metrics reflect the 12 months ending on the given month and year.
+    """
+
+    class Meta:
+        name = "propertyMetrics"

epa_pm_api_wrapper/models/property_metrics_list.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .property_metrics import PropertyMetrics
+
+
+@dataclass(kw_only=True)
+class PropertyMetricsList:
+    class Meta:
+        name = "propertyMetricsList"
+
+    property_metrics: list[PropertyMetrics] = field(
+        default_factory=list,
+        metadata={
+            "name": "propertyMetrics",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/property_metrics_type.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .metric import Metric
+from .period_type import PeriodType
+
+
+@dataclass(kw_only=True)
+class PropertyMetricsType:
+    """
+    :ivar metric:
+    :ivar year: The year of the period ending date for the set of
+        metrics.
+    :ivar month: The month of the period ending date for the set of
+        metrics.
+    :ivar period_type: The predefined period type used to generate the
+        report metric
+    :ivar property_id: The id of the property.
+    """
+
+    class Meta:
+        name = "propertyMetricsType"
+
+    metric: list[Metric] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+        },
+    )
+    year: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    month: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+            "min_inclusive": 1,
+            "max_inclusive": 12,
+        },
+    )
+    period_type: None | PeriodType = field(
+        default=None,
+        metadata={
+            "name": "periodType",
+            "type": "Attribute",
+        },
+    )
+    property_id: None | int = field(
+        default=None,
+        metadata={
+            "name": "propertyId",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/property_representation.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .property_representation_property_representation_type import (
+    PropertyRepresentationPropertyRepresentationType,
+)
+from .tenant_common_area_energy_use_information_type import (
+    TenantCommonAreaEnergyUseInformationType,
+)
+
+
+@dataclass(kw_only=True)
+class PropertyRepresentation:
+    """
+    Indication of what energy is covered by the energy meters you associate
+    together for calculations.
+
+    :ivar property_representation_type: Indication of what energy is
+        covered by the energy meters you associate together for
+        calculations
+    :ivar tenant_common_area_energy_use_list: Indicates the various
+        energy uses if a "Combination of Tenant and Common Area
+        Consumption" property representation type is selected. This is
+        only required when "Combination of Tenant and Common Area
+        Consumption" is specified. At least one of the 8 options must be
+        selected.
+    :ivar property_representation_type_other_desc: If you chose "Other"
+        for the property representation, this is the description.
+    """
+
+    class Meta:
+        name = "propertyRepresentation"
+
+    property_representation_type: PropertyRepresentationPropertyRepresentationType = field(
+        metadata={
+            "name": "propertyRepresentationType",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    tenant_common_area_energy_use_list: None | TenantCommonAreaEnergyUseInformationType = field(
+        default=None,
+        metadata={
+            "name": "tenantCommonAreaEnergyUseList",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    property_representation_type_other_desc: None | str = field(
+        default=None,
+        metadata={
+            "name": "propertyRepresentationTypeOtherDesc",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        },
+    )

epa_pm_api_wrapper/models/property_representation_property_representation_type.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class PropertyRepresentationPropertyRepresentationType(Enum):
+    """
+    :cvar WHOLE_PROPERTY: The energy meters are associated with the
+        whole property.
+    :cvar COMMON_AREA_ENERGY_CONSUMPTION_ONLY: The energy meters are
+        associated with the common area only.
+    :cvar TENANT_ENERGY_CONSUMPTION_ONLY: The energy meters are
+        associated with a combination of the tenant and common areas.
+    :cvar COMBINATION_OF_TENANT_AND_COMMON_AREA_CONSUMPTION: If
+        selected, you must specify the energy uses with the
+        "tenantCommonAreaEnergyUseList" XML element.
+    :cvar OTHER: The energy meters are not associated with any of the
+        given choices, you are specifiying "Other."
+    :cvar NO_SELECTION_MADE:
+    """
+
+    WHOLE_PROPERTY = "Whole Property"
+    COMMON_AREA_ENERGY_CONSUMPTION_ONLY = "Common Area Energy Consumption Only"
+    TENANT_ENERGY_CONSUMPTION_ONLY = "Tenant Energy Consumption Only"
+    COMBINATION_OF_TENANT_AND_COMMON_AREA_CONSUMPTION = "Combination of Tenant and Common Area Consumption"
+    OTHER = "Other"
+    NO_SELECTION_MADE = "No Selection Made"

epa_pm_api_wrapper/models/property_type.py

@@ -0,0 +1,192 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .address_type import AddressType
+from .agency_type import AgencyType
+from .construction_status_type import ConstructionStatusType
+from .country_list import CountryList
+from .gross_floor_area_type import GrossFloorAreaType
+from .irrigation_area_type import IrrigationAreaType
+from .log_type import LogType
+from .occupancy_type import OccupancyType
+from .primary_function_type import PrimaryFunctionType
+from .share_level_type import ShareLevelType
+
+
+@dataclass(kw_only=True)
+class PropertyType:
+    """
+    :ivar name: The name of the property.
+    :ivar construction_status: The construction status (either existing,
+        design or test project).
+    :ivar primary_function: The primary function of the building.
+    :ivar gross_floor_area: The Gross Floor Area
+    :ivar irrigated_area: The Irrigated Area
+    :ivar year_built: The year the property was built.
+    :ivar address:
+    :ivar number_of_buildings: The estimated number of buildings for
+        this property.
+    :ivar is_federal_property: Whether the property is federally owned.
+    :ivar federal_owner: The property physical address - country.
+    :ivar agency: The federal agency that owns or operates the building.
+    :ivar agency_department_region: Optional additional information
+        about the federal department or region.
+    :ivar federal_campus: Name of the Federal Campus
+    :ivar occupancy_percentage: The percentage occupancy of the
+        property.
+    :ivar notes: Notes about this property.
+    :ivar is_institutional_property: Whether the property is
+        institutional property.
+    :ivar access_level: Current share level for the user calling the
+        webservice.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "propertyType"
+
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 80,
+        },
+    )
+    construction_status: None | ConstructionStatusType = field(
+        default=None,
+        metadata={
+            "name": "constructionStatus",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    primary_function: None | PrimaryFunctionType = field(
+        default=None,
+        metadata={
+            "name": "primaryFunction",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    gross_floor_area: None | GrossFloorAreaType = field(
+        default=None,
+        metadata={
+            "name": "grossFloorArea",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    irrigated_area: None | IrrigationAreaType = field(
+        default=None,
+        metadata={
+            "name": "irrigatedArea",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    year_built: None | int = field(
+        default=None,
+        metadata={
+            "name": "yearBuilt",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    address: None | AddressType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    number_of_buildings: None | int = field(
+        default=None,
+        metadata={
+            "name": "numberOfBuildings",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    is_federal_property: bool = field(
+        metadata={
+            "name": "isFederalProperty",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    federal_owner: None | CountryList = field(
+        default=None,
+        metadata={
+            "name": "federalOwner",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    agency: None | AgencyType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    agency_department_region: None | str = field(
+        default=None,
+        metadata={
+            "name": "agencyDepartmentRegion",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 200,
+        },
+    )
+    federal_campus: None | str = field(
+        default=None,
+        metadata={
+            "name": "federalCampus",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 200,
+        },
+    )
+    occupancy_percentage: OccupancyType = field(
+        metadata={
+            "name": "occupancyPercentage",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    notes: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+        },
+    )
+    is_institutional_property: None | bool = field(
+        default=None,
+        metadata={
+            "name": "isInstitutionalProperty",
+            "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/property_use.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class PropertyUse:
+    """
+    This is used to update property use name only.
+    """
+
+    class Meta:
+        name = "propertyUse"
+
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        }
+    )

epa_pm_api_wrapper/models/race_track.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class RaceTrack(OtherType):
+    """
+    Buildings used primarily to hold racing events such as vehicle races,
+    track/field races, horse races, and/or dog-races.
+    """
+
+    class Meta:
+        name = "raceTrack"

epa_pm_api_wrapper/models/rated_capacity_uom_type.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RatedCapacityUomType(Enum):
+    K_W = "kW"
+    MW = "MW"

epa_pm_api_wrapper/models/rec_ownership_enum.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RecOwnershipEnum(Enum):
+    OWNED = "Owned"
+    NOT_OWNED_SOLD = "Not Owned/Sold"
+    ARBITRAGED = "Arbitraged"
+    UNKNOWN = "Unknown"

epa_pm_api_wrapper/models/refrigerated_warehouse.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .refrigerated_warehouse_type import RefrigeratedWarehouseType
+
+
+@dataclass(kw_only=True)
+class RefrigeratedWarehouse(RefrigeratedWarehouseType):
+    """
+    Refrigerated buildings that are used to store perishable goods or
+    merchandise under refrigeration at temperatures below 50 degrees
+    Fahrenheit.
+    """
+
+    class Meta:
+        name = "refrigeratedWarehouse"

epa_pm_api_wrapper/models/refrigerated_warehouse_type.py

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

epa_pm_api_wrapper/models/refrigerated_warehouse_type_use_details.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .clear_height import ClearHeight
+from .number_of_workers import NumberOfWorkers
+from .percent_cooled import PercentCooled
+from .percent_heated import PercentHeated
+from .percent_used_for_cold_storage import PercentUsedForColdStorage
+from .total_gross_floor_area import TotalGrossFloorArea
+from .weekly_operating_hours import WeeklyOperatingHours
+
+
+@dataclass(kw_only=True)
+class RefrigeratedWarehouseTypeUseDetails:
+    class Meta:
+        global_type = False
+
+    total_gross_floor_area: TotalGrossFloorArea = field(
+        metadata={
+            "name": "totalGrossFloorArea",
+            "type": "Element",
+        }
+    )
+    weekly_operating_hours: None | WeeklyOperatingHours = field(
+        default=None,
+        metadata={
+            "name": "weeklyOperatingHours",
+            "type": "Element",
+        },
+    )
+    number_of_workers: None | NumberOfWorkers = field(
+        default=None,
+        metadata={
+            "name": "numberOfWorkers",
+            "type": "Element",
+        },
+    )
+    percent_used_for_cold_storage: None | PercentUsedForColdStorage = field(
+        default=None,
+        metadata={
+            "name": "percentUsedForColdStorage",
+            "type": "Element",
+        },
+    )
+    clear_height: None | ClearHeight = field(
+        default=None,
+        metadata={
+            "name": "clearHeight",
+            "type": "Element",
+        },
+    )
+    percent_cooled: None | PercentCooled = field(
+        default=None,
+        metadata={
+            "name": "percentCooled",
+            "type": "Element",
+        },
+    )
+    percent_heated: None | PercentHeated = field(
+        default=None,
+        metadata={
+            "name": "percentHeated",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/renewable_generation_technology_enum.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class RenewableGenerationTechnologyEnum(Enum):
+    SOLAR_PV_CARPORTS = "Solar PV- Carports"
+    SOLAR_PV_GROUND_MOUNTED = "Solar PV- Ground-mounted"
+    SOLAR_PV_ROOFTOP = "Solar PV- Rooftop"
+    SOLAR_THERMAL_CONCENTRATING_SOLAR_POWER = "Solar Thermal- Concentrating Solar Power"
+    OTHER = "Other"