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

epa_pm_api_wrapper/models/report.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .report_properties import ReportProperties
+from .report_status_type import ReportStatusType
+from .report_type import ReportType
+from .timeframe_type import TimeframeType
+
+
+@dataclass(kw_only=True)
+class Report:
+    """
+    :ivar id: The unique identifier of the report.
+    :ivar type_value: The type of report.
+    :ivar timeframe: The timeframe the report will be run against.
+    :ivar template_id: The id of the template.
+    :ivar template_name: The name of the template.
+    :ivar properties: The list of properties that the report will be run
+        for.
+    :ivar report_generation_status: The current generation status of the
+        report.
+    """
+
+    class Meta:
+        name = "report"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+        },
+    )
+    type_value: None | ReportType = field(
+        default=None,
+        metadata={
+            "name": "type",
+            "type": "Element",
+        },
+    )
+    timeframe: TimeframeType = field(
+        metadata={
+            "type": "Element",
+        }
+    )
+    template_id: None | int = field(
+        default=None,
+        metadata={
+            "name": "templateId",
+            "type": "Element",
+        },
+    )
+    template_name: None | str = field(
+        default=None,
+        metadata={
+            "name": "templateName",
+            "type": "Element",
+        },
+    )
+    properties: None | ReportProperties = field(
+        default=None,
+        metadata={
+            "type": "Element",
+        },
+    )
+    report_generation_status: None | ReportStatusType = field(
+        default=None,
+        metadata={
+            "name": "reportGenerationStatus",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/report_error.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from xsdata.models.datatype import XmlDateTime
+
+from .report_error_missing_metrics import ReportErrorMissingMetrics
+
+
+@dataclass(kw_only=True)
+class ReportError:
+    """
+    :ivar report_id: The id of the report.
+    :ivar template_name: The name of the template.
+    :ivar date_generated: The timestamp when the report was generated
+    :ivar number_of_properties: The total count of the properties in the
+        report
+    :ivar missing_metrics:
+    """
+
+    class Meta:
+        name = "reportError"
+
+    report_id: int = field(
+        metadata={
+            "name": "reportId",
+            "type": "Element",
+        }
+    )
+    template_name: str = field(
+        metadata={
+            "name": "templateName",
+            "type": "Element",
+        }
+    )
+    date_generated: XmlDateTime = field(
+        metadata={
+            "name": "dateGenerated",
+            "type": "Element",
+        }
+    )
+    number_of_properties: int = field(
+        metadata={
+            "name": "numberOfProperties",
+            "type": "Element",
+        }
+    )
+    missing_metrics: ReportErrorMissingMetrics = field(
+        metadata={
+            "name": "missingMetrics",
+            "type": "Element",
+        }
+    )

epa_pm_api_wrapper/models/report_error_missing_metrics.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .report_error_missing_metrics_property_missing_metric import (
+    ReportErrorMissingMetricsPropertyMissingMetric,
+)
+
+
+@dataclass(kw_only=True)
+class ReportErrorMissingMetrics:
+    class Meta:
+        global_type = False
+
+    property_missing_metric: list[ReportErrorMissingMetricsPropertyMissingMetric] = field(
+        default_factory=list,
+        metadata={
+            "name": "propertyMissingMetric",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/report_error_missing_metrics_property_missing_metric.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from xsdata.models.datatype import XmlDate
+
+from .report_error_missing_metrics_property_missing_metric_metric import (
+    ReportErrorMissingMetricsPropertyMissingMetricMetric,
+)
+
+
+@dataclass(kw_only=True)
+class ReportErrorMissingMetricsPropertyMissingMetric:
+    class Meta:
+        global_type = False
+
+    year_ending_date: None | XmlDate = field(
+        default=None,
+        metadata={
+            "name": "yearEndingDate",
+            "type": "Element",
+        },
+    )
+    metric: list[ReportErrorMissingMetricsPropertyMissingMetricMetric] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+        },
+    )
+    property_id: None | int = field(
+        default=None,
+        metadata={
+            "name": "propertyId",
+            "type": "Attribute",
+        },
+    )
+    property_name: None | str = field(
+        default=None,
+        metadata={
+            "name": "propertyName",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/report_error_missing_metrics_property_missing_metric_metric.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class ReportErrorMissingMetricsPropertyMissingMetricMetric:
+    """
+    :ivar error:
+    :ivar name: The name of the metric.
+    :ivar id: The id of the metric.
+    """
+
+    class Meta:
+        global_type = False
+
+    error: str = field(
+        metadata={
+            "type": "Element",
+        }
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/report_metric_values_ws.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .period_type import PeriodType
+
+
+@dataclass(kw_only=True)
+class ReportMetricValuesWs:
+    """
+    :ivar value: The value of the Monthly metric.
+    :ivar month: The month of the period ending date for the set of
+        metrics.
+    :ivar year: The year of the period ending date for the set of
+        metrics.
+    :ivar period_type: The predefined period type used to generate the
+        report metric
+    :ivar auto_generated: Indicates whether the metric is automatically
+        generated by the system.
+    """
+
+    class Meta:
+        name = "reportMetricValuesWs"
+
+    value: list[str] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+            "nillable": True,
+        },
+    )
+    month: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    year: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    period_type: None | PeriodType = field(
+        default=None,
+        metadata={
+            "name": "periodType",
+            "type": "Attribute",
+        },
+    )
+    auto_generated: None | bool = field(
+        default=None,
+        metadata={
+            "name": "autoGenerated",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/report_metrics.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .report_metrics_group import ReportMetricsGroup
+
+
+@dataclass(kw_only=True)
+class ReportMetrics:
+    """
+    A collection of reporting metrics.
+
+    :ivar group: A group of metrics. This corresponds to the groups that
+        the metrics are organized into in the user interface.
+    """
+
+    class Meta:
+        name = "reportMetrics"
+
+    group: list[ReportMetricsGroup] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+            "min_occurs": 1,
+        },
+    )

epa_pm_api_wrapper/models/report_metrics_group.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .report_metrics_group_metrics import ReportMetricsGroupMetrics
+
+
+@dataclass(kw_only=True)
+class ReportMetricsGroup:
+    """
+    :ivar metrics:
+    :ivar id: The unique identifier of the metric group.
+    :ivar name: The name of the metric group as it appears in the user
+        interface.
+    """
+
+    class Meta:
+        global_type = False
+
+    metrics: ReportMetricsGroupMetrics = field(
+        metadata={
+            "type": "Element",
+        }
+    )
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/report_metrics_group_metrics.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .report_metrics_group_metrics_metric import (
+    ReportMetricsGroupMetricsMetric,
+)
+
+
+@dataclass(kw_only=True)
+class ReportMetricsGroupMetrics:
+    """
+    :ivar metric: The metric.
+    """
+
+    class Meta:
+        global_type = False
+
+    metric: list[ReportMetricsGroupMetricsMetric] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/report_metrics_group_metrics_metric.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class ReportMetricsGroupMetricsMetric:
+    """
+    :ivar id: The unique identifier of the metric.
+    :ivar name: The unique web service metric name identifier to
+        reference the metric.
+    :ivar description: The corresponding name of the metric as its
+        displayed in the user interface.
+    :ivar data_type: The datatype of the value returned by the metric
+        (text, numeric, or date).
+    :ivar uom: The unit of measure of the value returned by the metric
+        (if applicable).
+    :ivar available_to_custom_metrics: The flag that determines if the
+        metric is available for use in a Custom Metric.
+    """
+
+    class Meta:
+        global_type = False
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    description: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    data_type: None | str = field(
+        default=None,
+        metadata={
+            "name": "dataType",
+            "type": "Attribute",
+        },
+    )
+    uom: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    available_to_custom_metrics: None | bool = field(
+        default=None,
+        metadata={
+            "name": "availableToCustomMetrics",
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/report_properties.py

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

epa_pm_api_wrapper/models/report_status.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .report_status_def import ReportStatusDef
+
+
+@dataclass(kw_only=True)
+class ReportStatus(ReportStatusDef):
+    class Meta:
+        name = "reportStatus"

epa_pm_api_wrapper/models/report_status_def.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from xsdata.models.datatype import XmlDateTime
+
+from .report_status_type import ReportStatusType
+
+
+@dataclass(kw_only=True)
+class ReportStatusDef:
+    """
+    :ivar status: The status of the report.
+    :ivar description: This field is not currently being used.
+    :ivar generation_start_date: The date and timestamp of when the
+        report generation started (in EST).
+    :ivar generation_end_date: The date and timestamp of when the report
+        generation completed (in EST).
+    :ivar submitted_date: The date and timestamp of when the report was
+        submitted to be generated (in EST).
+    """
+
+    class Meta:
+        name = "reportStatusDef"
+
+    status: ReportStatusType = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    description: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    generation_start_date: None | XmlDateTime = field(
+        default=None,
+        metadata={
+            "name": "generationStartDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    generation_end_date: None | XmlDateTime = field(
+        default=None,
+        metadata={
+            "name": "generationEndDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    submitted_date: None | XmlDateTime = field(
+        default=None,
+        metadata={
+            "name": "submittedDate",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/report_status_type.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ReportStatusType(Enum):
+    """
+    The report status.
+
+    :cvar INITIALIZED: Indicates that the report was initially created
+        or its configuration (i.e., timeframe, properties, metrics,
+        etc.) has been updated.
+    :cvar SUBMITTED: Indicates that the report has been submitted for
+        generation and is waiting to be generated.
+    :cvar IN_PROCESS: Indicates that the report is currently being
+        generated.
+    :cvar FAILED: Indicates that the report encountered an unknown error
+        during the generation step.
+    :cvar GENERATED: Indicates that report has completed generation and
+        is available for download.
+    :cvar READY_FOR_DOWNLOAD: This status is currently not support yet.
+    :cvar GENERATED_WITH_ERRORS: This report is generated with errors.
+    :cvar SENT: This response has been sent to the requester.
+    """
+
+    INITIALIZED = "INITIALIZED"
+    SUBMITTED = "SUBMITTED"
+    IN_PROCESS = "IN_PROCESS"
+    FAILED = "FAILED"
+    GENERATED = "GENERATED"
+    READY_FOR_DOWNLOAD = "READY_FOR_DOWNLOAD"
+    GENERATED_WITH_ERRORS = "GENERATED_WITH_ERRORS"
+    SENT = "SENT"

epa_pm_api_wrapper/models/report_template.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .report_template_type import ReportTemplateType
+
+
+@dataclass(kw_only=True)
+class ReportTemplate(ReportTemplateType):
+    class Meta:
+        name = "reportTemplate"

epa_pm_api_wrapper/models/report_template_type.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .log_type import LogType
+from .report_template_type_metrics import ReportTemplateTypeMetrics
+from .template_type import TemplateType
+
+
+@dataclass(kw_only=True)
+class ReportTemplateType:
+    """
+    :ivar id: The unique identifier of the template.
+    :ivar name: The name of the template.
+    :ivar template_type: The type of the template. This is ignore in a
+        POST/PUT.
+    :ivar metrics: The list of metrics configured  to the template.
+    :ivar report_id: The unique identifier to the corresponding report.
+    :ivar audit:
+    """
+
+    class Meta:
+        name = "reportTemplateType"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+        },
+    )
+    name: str = field(
+        metadata={
+            "type": "Element",
+            "min_length": 1,
+            "max_length": 100,
+        }
+    )
+    template_type: None | TemplateType = field(
+        default=None,
+        metadata={
+            "name": "templateType",
+            "type": "Element",
+        },
+    )
+    metrics: None | ReportTemplateTypeMetrics = field(
+        default=None,
+        metadata={
+            "type": "Element",
+        },
+    )
+    report_id: None | int = field(
+        default=None,
+        metadata={
+            "name": "reportId",
+            "type": "Element",
+        },
+    )
+    audit: None | LogType = field(
+        default=None,
+        metadata={
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/report_template_type_metrics.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(kw_only=True)
+class ReportTemplateTypeMetrics:
+    """
+    :ivar id: The unique identifier to the individual metric configured
+        for the custom report.
+    """
+
+    class Meta:
+        global_type = False
+
+    id: list[int] = field(
+        default_factory=list,
+        metadata={
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/report_type.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ReportType(Enum):
+    """
+    The type of report.
+
+    :cvar CUSTOM: Custom report.
+    :cvar ENERGY_STAR: ENERGY STAR reports that are pre-defined (i.e.,
+        Water Performance, Energy Performance, etc.). This type is
+        currently not support yet.
+    """
+
+    CUSTOM = "CUSTOM"
+    ENERGY_STAR = "ENERGY_STAR"