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

epa_pm_api_wrapper/models/offsite_green_power_purchase_type.py

@@ -0,0 +1,224 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from xsdata.models.datatype import XmlDate
+
+from .generation_location_type import GenerationLocationType
+from .green_power_type_enum import GreenPowerTypeEnum
+from .log_type import LogType
+from .offsite_green_power_purchase_type_amount_purchased import (
+    OffsiteGreenPowerPurchaseTypeAmountPurchased,
+)
+from .offsite_green_power_purchase_type_cost import (
+    OffsiteGreenPowerPurchaseTypeCost,
+)
+from .offsite_green_power_purchase_type_fuel_sources import (
+    OffsiteGreenPowerPurchaseTypeFuelSources,
+)
+from .offsite_green_power_purchase_type_rated_capacity import (
+    OffsiteGreenPowerPurchaseTypeRatedCapacity,
+)
+from .offsite_green_power_purchase_type_renewable_generation_technologies import (
+    OffsiteGreenPowerPurchaseTypeRenewableGenerationTechnologies,
+)
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseType:
+    """
+    :ivar id: The id of the offsite green power purchase.
+    :ivar rec_owned_and_retired: You must own and retire the RECs (or
+        have them retired on your behalf) for them to count as green
+        power in Portfolio Manager.
+    :ivar start_date: The start date of the offsite green power
+        purchase.
+    :ivar end_date: The end date of the offsite green power purchase.
+    :ivar amount_purchased:
+    :ivar estimate: Flag to indicate if any of the amount purchased is
+        estimate.
+    :ivar generation_location: The location (power plant, eGrid
+        subregion, or unknown) of where the green power was generated.
+    :ivar type_value: The green power type of the offsite green power
+        purchase.
+    :ivar meet_vintage_requirement: You must attest that the unbundled
+        RECs meet the vintage requirement when type is Unbundled RECs.
+    :ivar certified_by_greene: Flag indicate whether this green power is
+        certified by Green-e.
+    :ivar provider: The green power provider/project owner.
+    :ivar facility_name: The generation facility name.
+    :ivar fuel_sources: The green power fuel sources.
+    :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 contract_start_date: The contract start date.
+    :ivar contract_end_date: The contract start date.
+    :ivar cost: The cost of Green Power purchase.
+    :ivar notes: Any other information about this purchase.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "offsiteGreenPowerPurchaseType"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    rec_owned_and_retired: bool = field(
+        metadata={
+            "name": "recOwnedAndRetired",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    start_date: XmlDate = field(
+        metadata={
+            "name": "startDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    end_date: XmlDate = field(
+        metadata={
+            "name": "endDate",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    amount_purchased: OffsiteGreenPowerPurchaseTypeAmountPurchased = field(
+        metadata={
+            "name": "amountPurchased",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    estimate: bool = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    generation_location: GenerationLocationType = field(
+        metadata={
+            "name": "generationLocation",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    type_value: GreenPowerTypeEnum = field(
+        metadata={
+            "name": "type",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    meet_vintage_requirement: None | bool = field(
+        default=None,
+        metadata={
+            "name": "meetVintageRequirement",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    certified_by_greene: bool = field(
+        metadata={
+            "name": "certifiedByGreene",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    provider: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        },
+    )
+    facility_name: None | str = field(
+        default=None,
+        metadata={
+            "name": "facilityName",
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 500,
+        },
+    )
+    fuel_sources: None | OffsiteGreenPowerPurchaseTypeFuelSources = field(
+        default=None,
+        metadata={
+            "name": "fuelSources",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    renewable_generation_technologies: None | OffsiteGreenPowerPurchaseTypeRenewableGenerationTechnologies = field(
+        default=None,
+        metadata={
+            "name": "renewableGenerationTechnologies",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    rated_capacity: None | OffsiteGreenPowerPurchaseTypeRatedCapacity = field(
+        default=None,
+        metadata={
+            "name": "ratedCapacity",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    operation_date: None | XmlDate = field(
+        default=None,
+        metadata={
+            "name": "operationDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    contract_start_date: None | XmlDate = field(
+        default=None,
+        metadata={
+            "name": "contractStartDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    contract_end_date: None | XmlDate = field(
+        default=None,
+        metadata={
+            "name": "contractEndDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    cost: None | OffsiteGreenPowerPurchaseTypeCost = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    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/offsite_green_power_purchase_type_amount_purchased.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .offsite_green_power_purchase_type_amount_purchased_percentage import (
+    OffsiteGreenPowerPurchaseTypeAmountPurchasedPercentage,
+)
+from .offsite_green_power_purchase_type_amount_purchased_quantity import (
+    OffsiteGreenPowerPurchaseTypeAmountPurchasedQuantity,
+)
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeAmountPurchased:
+    class Meta:
+        global_type = False
+
+    quantity: None | OffsiteGreenPowerPurchaseTypeAmountPurchasedQuantity = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    percentage: None | OffsiteGreenPowerPurchaseTypeAmountPurchasedPercentage = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_type_amount_purchased_percentage.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from .offsite_green_power_purchase_type_amount_purchased_percentage_meters import (
+    OffsiteGreenPowerPurchaseTypeAmountPurchasedPercentageMeters,
+)
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeAmountPurchasedPercentage:
+    """
+    :ivar value: The percentage purchased.
+    :ivar include_all_meters: Flag to indicate if all electric meters
+        are included.
+    :ivar meters: The list of electric meters included if
+        includeAllMeters is false.
+    """
+
+    class Meta:
+        global_type = False
+
+    value: Decimal = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "max_inclusive": Decimal("100"),
+            "fraction_digits": 1,
+        }
+    )
+    include_all_meters: bool = field(
+        metadata={
+            "name": "includeAllMeters",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    meters: None | OffsiteGreenPowerPurchaseTypeAmountPurchasedPercentageMeters = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_type_amount_purchased_percentage_meters.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeAmountPurchasedPercentageMeters:
+    """
+    :ivar id: The unique identifier for each meter.
+    """
+
+    class Meta:
+        global_type = False
+
+    id: list[int] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_type_amount_purchased_quantity.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from .energy_uom_type import EnergyUomType
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeAmountPurchasedQuantity:
+    """
+    :ivar amount: The amount purchased.
+    :ivar uom: The unit of measure of the amount purchased.
+    """
+
+    class Meta:
+        global_type = False
+
+    amount: Decimal = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_inclusive": Decimal("0.1"),
+            "fraction_digits": 1,
+        }
+    )
+    uom: EnergyUomType = field(
+        metadata={
+            "type": "Attribute",
+        }
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_type_cost.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from .energy_uom_type import EnergyUomType
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeCost:
+    """
+    :ivar value: The value of the cost.
+    :ivar uom: The unit of measure of the cost.
+    """
+
+    class Meta:
+        global_type = False
+
+    value: Decimal = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "fraction_digits": 2,
+        }
+    )
+    uom: EnergyUomType = field(
+        metadata={
+            "type": "Attribute",
+        }
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_type_fuel_sources.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .offsite_green_power_purchase_type_fuel_sources_fuel_source import (
+    OffsiteGreenPowerPurchaseTypeFuelSourcesFuelSource,
+)
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeFuelSources:
+    class Meta:
+        global_type = False
+
+    fuel_source: list[OffsiteGreenPowerPurchaseTypeFuelSourcesFuelSource] = field(
+        default_factory=list,
+        metadata={
+            "name": "fuelSource",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_type_fuel_sources_fuel_source.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from decimal import Decimal
+
+from .green_power_fuel_source_enum import GreenPowerFuelSourceEnum
+
+
+@dataclass(kw_only=True)
+class OffsiteGreenPowerPurchaseTypeFuelSourcesFuelSource:
+    """
+    :ivar type_value: The type of the fuel sources.
+    :ivar percentage: The percentage of the fuel source.
+    """
+
+    class Meta:
+        global_type = False
+
+    type_value: GreenPowerFuelSourceEnum = field(
+        metadata={
+            "name": "type",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    percentage: None | Decimal = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_exclusive": Decimal("0"),
+            "max_inclusive": Decimal("100"),
+            "fraction_digits": 1,
+        },
+    )

epa_pm_api_wrapper/models/offsite_green_power_purchase_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 OffsiteGreenPowerPurchaseTypeRatedCapacity:
+    """
+    :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/offsite_green_power_purchase_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 OffsiteGreenPowerPurchaseTypeRenewableGenerationTechnologies:
+    class Meta:
+        global_type = False
+
+    technology: list[RenewableGenerationTechnologyEnum] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/on_site_laundry_facility.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .use_yes_no_type import UseYesNoType
+
+
+@dataclass(kw_only=True)
+class OnSiteLaundryFacility(UseYesNoType):
+    """
+    Presence of an on-site Laundry Facility (Yes/No).
+    """
+
+    class Meta:
+        name = "onSiteLaundryFacility"

epa_pm_api_wrapper/models/onsite_laundry_type.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .onsite_laundry_type_value import OnsiteLaundryTypeValue
+from .use_attribute_base import UseAttributeBase
+
+
+@dataclass(kw_only=True)
+class OnsiteLaundryType(UseAttributeBase):
+    class Meta:
+        name = "onsiteLaundryType"
+
+    value: None | OnsiteLaundryTypeValue = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/onsite_laundry_type_value.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class OnsiteLaundryTypeValue(Enum):
+    LINENS_ONLY = "Linens only"
+    TERRY_ONLY = "Terry only"
+    BOTH_LINENS_AND_TERRY = "Both linens and terry"
+    NO_LAUNDRY_FACILITY = "No laundry facility"

epa_pm_api_wrapper/models/onsite_renewable_detail.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .onsite_renewable_detail_type import OnsiteRenewableDetailType
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableDetail(OnsiteRenewableDetailType):
+    class Meta:
+        name = "onsiteRenewableDetail"

epa_pm_api_wrapper/models/onsite_renewable_detail_type.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from xsdata.models.datatype import XmlDate
+
+from .log_type import LogType
+from .onsite_usage_detail_type import OnsiteUsageDetailType
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableDetailType:
+    """
+    :ivar id: The id of the onsite renewable detail.
+    :ivar current_as_of: The time period of the onsite renewable detail.
+    :ivar energy_used_onsite: The energy used onsite REC ownership
+        details.
+    :ivar energy_exported_to_grid: The energy exported to grid REC
+        ownership details.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "onsiteRenewableDetailType"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    current_as_of: XmlDate = field(
+        metadata={
+            "name": "currentAsOf",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    energy_used_onsite: OnsiteUsageDetailType = field(
+        metadata={
+            "name": "energyUsedOnsite",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    energy_exported_to_grid: OnsiteUsageDetailType = field(
+        metadata={
+            "name": "energyExportedToGrid",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/onsite_renewable_details.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .links_type import LinksType
+from .onsite_renewable_detail import OnsiteRenewableDetail
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableDetails:
+    class Meta:
+        name = "onsiteRenewableDetails"
+
+    onsite_renewable_detail: list[OnsiteRenewableDetail] = field(
+        default_factory=list,
+        metadata={
+            "name": "onsiteRenewableDetail",
+            "type": "Element",
+            "max_occurs": 1000,
+        },
+    )
+    links: None | LinksType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/onsite_renewable_optional_info.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .onsite_renewable_optional_info_type import (
+    OnsiteRenewableOptionalInfoType,
+)
+
+
+@dataclass(kw_only=True)
+class OnsiteRenewableOptionalInfo(OnsiteRenewableOptionalInfoType):
+    class Meta:
+        name = "onsiteRenewableOptionalInfo"