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

epa_pm_api_wrapper/models/onsite_renewable_optional_info_type.py

@@ -0,0 +1,134 @@
+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 .onsite_renewable_optional_info_type_rated_capacity import (
+    OnsiteRenewableOptionalInfoTypeRatedCapacity,
+)
+from .onsite_renewable_optional_info_type_renewable_generation_technologies import (
+    OnsiteRenewableOptionalInfoTypeRenewableGenerationTechnologies,
+)
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableOptionalInfoType:
+    """
+    :ivar project_name: The project name.
+    :ivar renewable_generation_technologies: The Renewable Generation
+        Technology types.
+    :ivar rated_capacity: The rated capacity of project/offtake.
+    :ivar operation_date: The commercial operation date.
+    :ivar number_of_inverters: The number of inverters.
+    :ivar number_of_solar_panels: The number of solar panels.
+    :ivar total_cost: the total investment cost of the project in $.
+    :ivar incentive_or_rebate_amount: The amount of incentives or
+        rebates obtained for the project in $.
+    :ivar estimated_savings: The estimated cost savings of the project
+        in $.
+    :ivar notes: Any other information about the renewable energy.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "onsiteRenewableOptionalInfoType"
+
+    project_name: None | str = field(
+        default=None,
+        metadata={
+            "name": "projectName",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        },
+    )
+    renewable_generation_technologies: None | OnsiteRenewableOptionalInfoTypeRenewableGenerationTechnologies = field(
+        default=None,
+        metadata={
+            "name": "renewableGenerationTechnologies",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    rated_capacity: None | OnsiteRenewableOptionalInfoTypeRatedCapacity = field(
+        default=None,
+        metadata={
+            "name": "ratedCapacity",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    operation_date: None | XmlDate = field(
+        default=None,
+        metadata={
+            "name": "operationDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    number_of_inverters: None | int = field(
+        default=None,
+        metadata={
+            "name": "numberOfInverters",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    number_of_solar_panels: None | int = field(
+        default=None,
+        metadata={
+            "name": "numberOfSolarPanels",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    total_cost: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "totalCost",
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "fraction_digits": 2,
+        },
+    )
+    incentive_or_rebate_amount: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "incentiveOrRebateAmount",
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "fraction_digits": 2,
+        },
+    )
+    estimated_savings: None | Decimal = field(
+        default=None,
+        metadata={
+            "name": "estimatedSavings",
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "fraction_digits": 2,
+        },
+    )
+    notes: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 4000,
+        },
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/onsite_renewable_optional_info_type_rated_capacity.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from .rated_capacity_uom_type import RatedCapacityUomType
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableOptionalInfoTypeRatedCapacity:
+    """
+    :ivar value:
+    :ivar uom: The unit of the value (kW or MW).
+    """
+
+    class Meta:
+        global_type = False
+
+    value: Decimal = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "fraction_digits": 1,
+        }
+    )
+    uom: RatedCapacityUomType = field(
+        metadata={
+            "type": "Attribute",
+        }
+    )

epa_pm_api_wrapper/models/onsite_renewable_optional_info_type_renewable_generation_technologies.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .renewable_generation_technology_enum import (
+    RenewableGenerationTechnologyEnum,
+)
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableOptionalInfoTypeRenewableGenerationTechnologies:
+    class Meta:
+        global_type = False
+
+    technology: list[RenewableGenerationTechnologyEnum] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/onsite_usage_detail_type.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .generation_location_type import GenerationLocationType
+from .green_power_type_enum import GreenPowerTypeEnum
+from .rec_ownership_enum import RecOwnershipEnum
+
+
+@dataclass(kw_only=True)
+class OnsiteUsageDetailType:
+    """
+    :ivar rec_ownership: The REC ownership type.
+    :ivar generation_location: The generation location of the REC,
+        required when recOwnership is Arbitraged. Defaults to property's
+        facility location when recOwnership is Owned. Not applicable
+        when recOwnership is Not Owned/Sold or Unknown.
+    :ivar green_power_type: The green power type, required when the
+        recOwnership is Arbitraged, not applicable for other
+        recOwnership types.
+    :ivar meet_vintage_requirement: You must attest that the unbundled
+        RECs meet the vintage requirement when green power type is
+        Unbundled RECs.
+    :ivar certified_by_greene: Flag indicate if certified by Green-e,
+        required when the recOwnership is Arbitraged, not applicable for
+        other recOwnership types.
+    """
+
+    class Meta:
+        name = "onsiteUsageDetailType"
+
+    rec_ownership: RecOwnershipEnum = field(
+        metadata={
+            "name": "recOwnership",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    generation_location: None | GenerationLocationType = field(
+        default=None,
+        metadata={
+            "name": "generationLocation",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    green_power_type: None | GreenPowerTypeEnum = field(
+        default=None,
+        metadata={
+            "name": "greenPowerType",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    meet_vintage_requirement: None | bool = field(
+        default=None,
+        metadata={
+            "name": "meetVintageRequirement",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    certified_by_greene: None | bool = field(
+        default=None,
+        metadata={
+            "name": "certifiedByGreene",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/open_footage.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .gross_floor_area_type import GrossFloorAreaType
+
+
+@dataclass(kw_only=True)
+class OpenFootage(GrossFloorAreaType):
+    """
+    Total area of open parking lots/areas.
+    """
+
+    class Meta:
+        name = "openFootage"

epa_pm_api_wrapper/models/open_on_weekends.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .use_yes_no_type import UseYesNoType
+
+
+@dataclass(kw_only=True)
+class OpenOnWeekends(UseYesNoType):
+    """
+    Indication of regular activities that occur on either Saturday or
+    Sunday (Yes/No).
+    """
+
+    class Meta:
+        name = "openOnWeekends"

epa_pm_api_wrapper/models/optional_floor_area_type.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .floor_area_type_base import FloorAreaTypeBase
+
+
+@dataclass(kw_only=True)
+class OptionalFloorAreaType(FloorAreaTypeBase):
+    class Meta:
+        name = "optionalFloorAreaType"
+
+    value: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/organization_type.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .primary_business_type import PrimaryBusinessType
+from .type_of_energy_star_partner import TypeOfEnergyStarPartner
+
+
+@dataclass(kw_only=True)
+class OrganizationType:
+    """
+    :ivar primary_business: Your primary business.
+    :ivar other_business_description: Describes other if you chose other
+        as your primary business.
+    :ivar energy_star_partner: Whether organization is an ENERGY STAR
+        Partner.
+    :ivar energy_star_partner_type: Whether organization is an ENERGY
+        STAR SPP Partner. Only required if the organization is an ENERGY
+        STAR Partner.
+    :ivar other_partner_description: Describes other if you chose other
+        as your energy star partner.
+    :ivar name: Your Organization's name.
+    """
+
+    class Meta:
+        name = "organizationType"
+
+    primary_business: PrimaryBusinessType = field(
+        metadata={
+            "name": "primaryBusiness",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    other_business_description: None | str = field(
+        default=None,
+        metadata={
+            "name": "otherBusinessDescription",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 1000,
+        },
+    )
+    energy_star_partner: bool = field(
+        metadata={
+            "name": "energyStarPartner",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    energy_star_partner_type: None | TypeOfEnergyStarPartner = field(
+        default=None,
+        metadata={
+            "name": "energyStarPartnerType",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    other_partner_description: None | str = field(
+        default=None,
+        metadata={
+            "name": "otherPartnerDescription",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 100,
+        },
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 1000,
+        },
+    )

epa_pm_api_wrapper/models/other.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class Other(OtherType):
+    """
+    Buildings that do not fall within any of the available property use
+    categories in Portfolio Manager.
+    """
+
+    class Meta:
+        name = "other"

epa_pm_api_wrapper/models/other_education.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherEducation(OtherType):
+    """
+    Buildings used for religious, community, or other educational purposes
+    not described in the available property uses in Portfolio Manager (i.e.
+    educational purposes other than adult education, college/university,
+    K-12 school, pre-school/daycare and vocational schools).
+    """
+
+    class Meta:
+        name = "otherEducation"

epa_pm_api_wrapper/models/other_entertainment_public_assembly.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherEntertainmentPublicAssembly(OtherType):
+    """
+    Buildings whose primary use is for entertainment or public gatherings
+    and that do not meet the definition of any other property use defined
+    in Portfolio Manager.
+    """
+
+    class Meta:
+        name = "otherEntertainmentPublicAssembly"

epa_pm_api_wrapper/models/other_lodging_residential.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherLodgingResidential(OtherType):
+    """
+    Buildings used for residential purposes other than those described in
+    the available property uses in Portfolio Manager (i.e. residential
+    other than multifamily residential, single family home, senior care
+    community, residence hall/dormitory, barracks, prison/incarceration, or
+    hotel).
+    """
+
+    class Meta:
+        name = "otherLodgingResidential"

epa_pm_api_wrapper/models/other_mall.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherMall(OtherType):
+    """
+    Buildings containing a collection of stores whose purpose is the sale
+    of goods, but which do not fit into the enclosed mall, lifestyle
+    center, or strip mall property types.
+    """
+
+    class Meta:
+        name = "otherMall"

epa_pm_api_wrapper/models/other_public_services.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherPublicServices(OtherType):
+    """
+    Buildings used by public-sector organizations to provide public
+    services other than those described in the available property uses in
+    Portfolio Manager (i.e. services other than offices, courthouses,
+    drinking water treatment and distribution plants, fire stations,
+    libraries, mailing centers or post offices, police stations, prisons or
+    incarceration facilities, social or meeting halls, transportation
+    terminals or stations, or wastewater treatment plants).
+    """
+
+    class Meta:
+        name = "otherPublicServices"

epa_pm_api_wrapper/models/other_recreation.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherRecreation(OtherType):
+    """
+    Buildings primarily used for recreation that do not meet the definition
+    of any other property use defined in Portfolio Manager.
+    """
+
+    class Meta:
+        name = "otherRecreation"

epa_pm_api_wrapper/models/other_restaurant_bar.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherRestaurantBar(OtherType):
+    """
+    Buildings used for preparation and sale of ready-to-eat food and
+    beverages, but which does not fit into the fast food restaurant,
+    restaurant, or bar/nightclub property types.
+    """
+
+    class Meta:
+        name = "otherRestaurantBar"

epa_pm_api_wrapper/models/other_services.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherServices(OtherType):
+    """
+    Buildings in which primarily services are offered, but which does not
+    fit into the Personal Services or Repair Services property types.
+    """
+
+    class Meta:
+        name = "otherServices"

epa_pm_api_wrapper/models/other_speciality_hospital.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class OtherSpecialityHospital(OtherType):
+    """
+    Long-term acute care hospitals, inpatient rehabilitation facilities,
+    including Cancer Centers and Psychiatric and Substance Abuse
+    Hospitals/Facilities.
+    """
+
+    class Meta:
+        name = "otherSpecialityHospital"

epa_pm_api_wrapper/models/other_stadium.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_stadium_type import OtherStadiumType
+
+
+@dataclass(kw_only=True)
+class OtherStadium(OtherStadiumType):
+    """
+    Buildings primarily used for sporting events that do not meet the
+    definition of any other property use defined in Portfolio Manager.
+    """
+
+    class Meta:
+        name = "otherStadium"

epa_pm_api_wrapper/models/other_stadium_type.py

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