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

epa_pm_api_wrapper/models/custom_field_list.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .custom_field_list_custom_field import CustomFieldListCustomField
+
+
+@dataclass(kw_only=True)
+class CustomFieldList:
+    class Meta:
+        name = "customFieldList"
+
+    custom_field: list[CustomFieldListCustomField] = field(
+        default_factory=list,
+        metadata={
+            "name": "customField",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/custom_field_list_custom_field.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class CustomFieldListCustomField:
+    class Meta:
+        global_type = False
+
+    value: str = field(default="")
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/custom_field_valid_characters.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CustomFieldValidCharacters(Enum):
+    """
+    :cvar ANY: Any character allowed
+    :cvar ALPHANUMERIC: Alphanumeric Characters only
+    :cvar NUMERIC: Numeric Characters only
+    """
+
+    ANY = "Any"
+    ALPHANUMERIC = "Alphanumeric"
+    NUMERIC = "Numeric"

epa_pm_api_wrapper/models/custom_field_when_to_prompt.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CustomFieldWhenToPrompt(Enum):
+    """
+    :cvar ONCE: Just ask once and apply it to every transaction
+    :cvar PROPERTY: Ask for every property
+    :cvar METER: Ask for every meter
+    """
+
+    ONCE = "Once"
+    PROPERTY = "Property"
+    METER = "Meter"

epa_pm_api_wrapper/models/custom_metric.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class CustomMetric:
+    """
+    :ivar name:
+    :ivar numerator_metric_id:
+    :ivar denominator_detail_type_id:
+    :ivar id: The unique identifier of the custom metric.
+    :ivar unit_of_measure:
+    """
+
+    class Meta:
+        name = "customMetric"
+
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+        },
+    )
+    numerator_metric_id: int = field(
+        metadata={
+            "name": "numeratorMetricId",
+            "type": "Element",
+        }
+    )
+    denominator_detail_type_id: int = field(
+        metadata={
+            "name": "denominatorDetailTypeId",
+            "type": "Element",
+        }
+    )
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    unit_of_measure: None | str = field(
+        default=None,
+        metadata={
+            "name": "unitOfMeasure",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/custom_units_type.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CustomUnitsType(Enum):
+    FEET = "Feet"
+    GALLONS_US = "Gallons (US)"
+    GALLONS_UK = "Gallons (UK)"
+    KILOGRAM = "Kilogram"
+    METERS = "Meters"
+    TONNES_METRIC = "Tonnes (metric)"
+    OTHER = "Other"
+    POUNDS = "Pounds"
+    SQUARE_FEET = "Square Feet"
+    SQUARE_METERS = "Square Meters"
+    TONS_SHORT = "Tons (short)"
+    THERMS = "Therms"
+    K_WH_THOUSAND_WATT_HOURS = "kWh (thousand Watt-hours)"

epa_pm_api_wrapper/models/custom_use.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .custom_use_type import CustomUseType
+
+
+@dataclass(kw_only=True)
+class CustomUse(CustomUseType):
+    """
+    A user-defined property use with custom user-defined use details.
+    """
+
+    class Meta:
+        name = "customUse"

epa_pm_api_wrapper/models/custom_use_detail1.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .custom_use_details_type import CustomUseDetailsType
+
+
+@dataclass(kw_only=True)
+class CustomUseDetail1(CustomUseDetailsType):
+    """
+    Custom Use Detail #1.
+    """
+
+    class Meta:
+        name = "customUseDetail1"

epa_pm_api_wrapper/models/custom_use_detail2.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .custom_use_details_type import CustomUseDetailsType
+
+
+@dataclass(kw_only=True)
+class CustomUseDetail2(CustomUseDetailsType):
+    """
+    Custom Use Detail #2.
+    """
+
+    class Meta:
+        name = "customUseDetail2"

epa_pm_api_wrapper/models/custom_use_details_type.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .custom_units_type import CustomUnitsType
+from .custom_use_details_type_data_type import CustomUseDetailsTypeDataType
+from .use_attribute_base import UseAttributeBase
+
+
+@dataclass(kw_only=True)
+class CustomUseDetailsType(UseAttributeBase):
+    class Meta:
+        name = "customUseDetailsType"
+
+    value: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    custom_name: None | str = field(
+        default=None,
+        metadata={
+            "name": "customName",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    custom_uom: None | str = field(
+        default=None,
+        metadata={
+            "name": "customUom",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    units: None | CustomUnitsType = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    data_type: None | CustomUseDetailsTypeDataType = field(
+        default=None,
+        metadata={
+            "name": "dataType",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/custom_use_details_type_data_type.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CustomUseDetailsTypeDataType(Enum):
+    NUMERIC = "numeric"
+    STRING = "string"

epa_pm_api_wrapper/models/custom_use_type.py

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

epa_pm_api_wrapper/models/custom_use_type_use_details.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .custom_use_detail1 import CustomUseDetail1
+from .custom_use_detail2 import CustomUseDetail2
+
+
+@dataclass(kw_only=True)
+class CustomUseTypeUseDetails:
+    class Meta:
+        global_type = False
+
+    custom_use_detail1: None | CustomUseDetail1 = field(
+        default=None,
+        metadata={
+            "name": "customUseDetail1",
+            "type": "Element",
+        },
+    )
+    custom_use_detail2: None | CustomUseDetail2 = field(
+        default=None,
+        metadata={
+            "name": "customUseDetail2",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/customer.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .account_info import AccountInfo
+from .customer_language_preference import CustomerLanguagePreference
+
+
+@dataclass(kw_only=True)
+class Customer:
+    """
+    Contains information for a Portfolio Manager account.
+
+    :ivar username: The username for your customer's account.
+    :ivar include_test_properties_in_graphics: This indicates if the
+        Test Property in the account is included in the graphs on My
+        Portfolio page. If true then test property is included and if
+        false then Test property is excluded.
+    :ivar email_preference_canadian_account: Contact me with training
+        opportunities, tool updates, program news and other information
+        about the ENERGY STAR program.
+    :ivar billboard_metric: Your saved billboard metric
+    :ivar language_preference:
+    :ivar account_info:
+    """
+
+    class Meta:
+        name = "customer"
+
+    username: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 60,
+        },
+    )
+    include_test_properties_in_graphics: None | bool = field(
+        default=None,
+        metadata={
+            "name": "includeTestPropertiesInGraphics",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    email_preference_canadian_account: None | bool = field(
+        default=None,
+        metadata={
+            "name": "emailPreferenceCanadianAccount",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    billboard_metric: None | str = field(
+        default=None,
+        metadata={
+            "name": "billboardMetric",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    language_preference: None | CustomerLanguagePreference = field(
+        default=None,
+        metadata={
+            "name": "languagePreference",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    account_info: None | AccountInfo = field(
+        default=None,
+        metadata={
+            "name": "accountInfo",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/customer_language_preference.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class CustomerLanguagePreference(Enum):
+    EN_US = "en_US"
+    FR_CA = "fr_CA"
+    ES_US = "es_US"

epa_pm_api_wrapper/models/data_center.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .data_center_type import DataCenterType
+
+
+@dataclass(kw_only=True)
+class DataCenter(DataCenterType):
+    """
+    Buildings specifically designed and equipped to meet the needs of high
+    density computing equipment, such as server racks, used for data
+    storage and processing.
+    """
+
+    class Meta:
+        name = "dataCenter"

epa_pm_api_wrapper/models/data_center_type.py

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

epa_pm_api_wrapper/models/data_center_type_use_details.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .cooling_equipment_redundancy import CoolingEquipmentRedundancy
+from .estimates_applied import EstimatesApplied
+from .it_energy_meter_configuration import ItEnergyMeterConfiguration
+from .total_gross_floor_area import TotalGrossFloorArea
+from .ups_system_redundancy import UpsSystemRedundancy
+
+
+@dataclass(kw_only=True)
+class DataCenterTypeUseDetails:
+    class Meta:
+        global_type = False
+
+    total_gross_floor_area: TotalGrossFloorArea = field(
+        metadata={
+            "name": "totalGrossFloorArea",
+            "type": "Element",
+        }
+    )
+    estimates_applied: None | EstimatesApplied = field(
+        default=None,
+        metadata={
+            "name": "estimatesApplied",
+            "type": "Element",
+        },
+    )
+    cooling_equipment_redundancy: None | CoolingEquipmentRedundancy = field(
+        default=None,
+        metadata={
+            "name": "coolingEquipmentRedundancy",
+            "type": "Element",
+        },
+    )
+    it_energy_meter_configuration: None | ItEnergyMeterConfiguration = field(
+        default=None,
+        metadata={
+            "name": "itEnergyMeterConfiguration",
+            "type": "Element",
+        },
+    )
+    ups_system_redundancy: None | UpsSystemRedundancy = field(
+        default=None,
+        metadata={
+            "name": "upsSystemRedundancy",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/data_exchange_settings.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .data_exchange_settings_supported_meter_types import (
+    DataExchangeSettingsSupportedMeterTypes,
+)
+from .data_exchange_settings_terms_of_use import DataExchangeSettingsTermsOfUse
+
+
+@dataclass(kw_only=True)
+class DataExchangeSettings:
+    """
+    :ivar supported_meter_types: The list of meter types that you
+        support.
+    :ivar terms_of_use:
+    """
+
+    class Meta:
+        name = "dataExchangeSettings"
+
+    supported_meter_types: None | DataExchangeSettingsSupportedMeterTypes = field(
+        default=None,
+        metadata={
+            "name": "supportedMeterTypes",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    terms_of_use: None | DataExchangeSettingsTermsOfUse = field(
+        default=None,
+        metadata={
+            "name": "termsOfUse",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/data_exchange_settings_supported_meter_types.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .all_meter_types import AllMeterTypes
+
+
+@dataclass(kw_only=True)
+class DataExchangeSettingsSupportedMeterTypes:
+    class Meta:
+        global_type = False
+
+    meter_type: list[AllMeterTypes] = field(
+        default_factory=list,
+        metadata={
+            "name": "meterType",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/data_exchange_settings_terms_of_use.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .empty_type import EmptyType
+
+
+@dataclass(kw_only=True)
+class DataExchangeSettingsTermsOfUse:
+    """
+    :ivar none: You do not have any Terms of Use to provide.
+    :ivar text: The text that you want to use for your Terms of Use.
+    :ivar url: The URL that customers can reference for the Terms of
+        Use.
+    """
+
+    class Meta:
+        global_type = False
+
+    none: None | EmptyType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    text: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    url: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )