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

epa_pm_api_wrapper/models/accept_reject_type.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AcceptRejectType(Enum):
+    """
+    The response to the sharing request.
+    """
+
+    ACCEPT = "Accept"
+    REJECT = "Reject"

epa_pm_api_wrapper/models/account.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .account_type import AccountType
+
+
+@dataclass(kw_only=True)
+class Account(AccountType):
+    """
+    Contains information for a Portfolio Manager account.
+    """
+
+    class Meta:
+        name = "account"

epa_pm_api_wrapper/models/account_info.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .address_type import AddressType
+
+
+@dataclass(kw_only=True)
+class AccountInfo:
+    class Meta:
+        name = "accountInfo"
+
+    first_name: str = field(
+        metadata={
+            "name": "firstName",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    last_name: str = field(
+        metadata={
+            "name": "lastName",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    email: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    address: AddressType = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    job_title: str = field(
+        metadata={
+            "name": "jobTitle",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    phone: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    organization: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/account_type.py

@@ -0,0 +1,122 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .account_type_language_preference import AccountTypeLanguagePreference
+from .contact_type import ContactType
+from .organization_type import OrganizationType
+
+
+@dataclass(kw_only=True)
+class AccountType:
+    """
+    :ivar id: The ID to the account.  This is ignored if specified in a
+        XML request.  This is provided by Portfolio Manager only in a
+        XML response.
+    :ivar username: Your username.
+    :ivar password: Your password.  The password must be at least 8
+        characters in length and must contain 3 out of  4 of the
+        following requirements: (i) uppercase characters, (ii) lowercase
+        characters, (iii) base 10 digits (0 through 9), and (iv)
+        nonalphanumeric characters:
+        ~!@#$%^&*_-+=`|\\(){}[]:;"'<>,.?/
+    :ivar contact:
+    :ivar organization:
+    :ivar webservice_user: Whether you will be using web services.
+    :ivar searchable: Whether you want people to be able to search for
+        you.
+    :ivar include_test_properties_in_graphics: Indicates whether
+        properties marked as “Test Properties” in the account will be
+        included in the charts and graphs on My Portfolio page.
+    :ivar email_preference_canadian_account: This setting ONLY applies
+        to accounts belonging to Canada.  NRCAN (Natural Resources of
+        Canada) can contact you 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:
+    """
+
+    class Meta:
+        name = "accountType"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        },
+    )
+    username: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 60,
+        }
+    )
+    password: str = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 8,
+            "max_length": 120,
+        }
+    )
+    contact: ContactType = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    organization: OrganizationType = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    webservice_user: bool = field(
+        metadata={
+            "name": "webserviceUser",
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    searchable: bool = field(
+        metadata={
+            "type": "Element",
+            "namespace": "",
+        }
+    )
+    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 | AccountTypeLanguagePreference = field(
+        default=None,
+        metadata={
+            "name": "languagePreference",
+            "type": "Element",
+            "namespace": "",
+        },
+    )

epa_pm_api_wrapper/models/account_type_language_preference.py

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

epa_pm_api_wrapper/models/additional_identifier.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .additional_identifier_type import AdditionalIdentifierType
+
+
+@dataclass(kw_only=True)
+class AdditionalIdentifier:
+    """
+    The values associated to the additional property/meter identifier for a
+    given property.
+
+    This is used when you provide the values (update or add) to an
+    additional property identifier for a specific property.
+
+    :ivar additional_identifier_type:
+    :ivar description: The description of the specific additional
+        property identifier when values are provided for it.
+    :ivar value: The value of the additional property identifier for a
+        specific property.
+    :ivar id: The id of the transaction when values are provided for a
+        specific additional property identifier and property.
+    """
+
+    class Meta:
+        name = "additionalIdentifier"
+
+    additional_identifier_type: AdditionalIdentifierType = field(
+        metadata={
+            "name": "additionalIdentifierType",
+            "type": "Element",
+        }
+    )
+    description: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 1000,
+        },
+    )
+    value: None | str = field(
+        default=None,
+        metadata={
+            "type": "Element",
+            "namespace": "",
+            "min_length": 1,
+            "max_length": 4000,
+        },
+    )
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/additional_identifier_type.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .additional_identifier_type_group import AdditionalIdentifierTypeGroup
+
+
+@dataclass(kw_only=True)
+class AdditionalIdentifierType:
+    """
+    The additional property identifier that EPA has approved for use.
+
+    This is used when you just want to get the complete static list of
+    additional property identifiers. This set includes the unique
+    identifier #1, #2, and #3 and the set that EPA is maintaining/approved.
+
+    :ivar id: The id of the additional property identifier
+    :ivar standard_approved: Whether the additional property identifier
+        is from the standard list that EPA is maintaining (versus the
+        generic set of 3 unique identifier fields that can be used)
+    :ivar name: The name of the additional property identifier
+    :ivar description: The description of the additional property
+        identifier.
+    :ivar group: The group of the additional property identifier.
+    """
+
+    class Meta:
+        name = "additionalIdentifierType"
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    standard_approved: None | bool = field(
+        default=None,
+        metadata={
+            "name": "standardApproved",
+            "type": "Attribute",
+        },
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    description: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    group: None | AdditionalIdentifierTypeGroup = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )

epa_pm_api_wrapper/models/additional_identifier_type_group.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AdditionalIdentifierTypeGroup(Enum):
+    CITY_TOWN = "CITY_TOWN"
+    COUNTY_DISTRICT = "COUNTY_DISTRICT"
+    STATE_PROVINCE = "STATE_PROVINCE"
+    OTHER = "OTHER"

epa_pm_api_wrapper/models/additional_identifier_types.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .additional_identifier_type import AdditionalIdentifierType
+
+
+@dataclass(kw_only=True)
+class AdditionalIdentifierTypes:
+    class Meta:
+        name = "additionalIdentifierTypes"
+
+    additional_identifier_type: list[AdditionalIdentifierType] = field(
+        default_factory=list,
+        metadata={
+            "name": "additionalIdentifierType",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/additional_identifiers.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .additional_identifier import AdditionalIdentifier
+
+
+@dataclass(kw_only=True)
+class AdditionalIdentifiers:
+    class Meta:
+        name = "additionalIdentifiers"
+
+    additional_identifier: list[AdditionalIdentifier] = field(
+        default_factory=list,
+        metadata={
+            "name": "additionalIdentifier",
+            "type": "Element",
+        },
+    )

epa_pm_api_wrapper/models/address_type.py

@@ -0,0 +1,84 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .address_type_state import AddressTypeState
+from .country_list import CountryList
+
+
+@dataclass(kw_only=True)
+class AddressType:
+    """
+    :ivar address1: The property physical address  - line 1.
+    :ivar address2: The property physical address  - line 2.
+    :ivar city: The property physical address - city.
+    :ivar county: The property physical address - county.
+    :ivar postal_code: The property physical address - postal code/zip
+        code.
+    :ivar state: The property physical address - state or province.
+    :ivar other_state: The property physical address - state or province
+        (when not US/Canada).
+    :ivar country: The property physical address - country.
+    """
+
+    class Meta:
+        name = "addressType"
+
+    address1: str = field(
+        metadata={
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 100,
+        }
+    )
+    address2: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 100,
+        },
+    )
+    city: str = field(
+        metadata={
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 100,
+        }
+    )
+    county: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 40,
+        },
+    )
+    postal_code: str = field(
+        metadata={
+            "name": "postalCode",
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 20,
+        }
+    )
+    state: None | AddressTypeState = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    other_state: None | str = field(
+        default=None,
+        metadata={
+            "name": "otherState",
+            "type": "Attribute",
+            "min_length": 1,
+            "max_length": 50,
+        },
+    )
+    country: CountryList = field(
+        metadata={
+            "type": "Attribute",
+        }
+    )

epa_pm_api_wrapper/models/address_type_state.py

@@ -0,0 +1,159 @@
+from __future__ import annotations
+
+from enum import Enum
+
+
+class AddressTypeState(Enum):
+    """
+    :cvar AK: Alaska in United States
+    :cvar AL: Alabama in United States
+    :cvar AR: Arkansas in United States
+    :cvar AS: American Samoa in United States
+    :cvar AZ: Arizona in United States
+    :cvar CA: California in United States
+    :cvar CO: Colorado in United States
+    :cvar CT: Connecticut in United States
+    :cvar DC: District of Columbia (D.C.) in United States
+    :cvar DE: Delaware in United States
+    :cvar FL: Florida in United States
+    :cvar GA: Georgia in United States
+    :cvar GU: Guam in United States
+    :cvar HI: Hawaii in United States
+    :cvar IA: Iowa in United States
+    :cvar ID: Idaho in United States
+    :cvar IL: Illinois in United States
+    :cvar IN: Indiana in United States
+    :cvar KS: Kansas in United States
+    :cvar KY: Kentucky in United States
+    :cvar LA: Louisiana in United States
+    :cvar MA: Massachusetts in United States
+    :cvar MD: Maryland in United States
+    :cvar ME: Maine in United States
+    :cvar MH: Marshall Islands in United States
+    :cvar MI: Michigan in United States
+    :cvar MN: Minnesota in United States
+    :cvar MO: Missouri in United States
+    :cvar MP: Northern Mariana Islands in United States
+    :cvar MS: Mississippi in United States
+    :cvar MT: Montana in United States
+    :cvar NC: North Carolina in United States
+    :cvar ND: North Dakota in United States
+    :cvar NE: Nebraska in United States
+    :cvar NH: New Hampshire in United States
+    :cvar NJ: New Jersey in United States
+    :cvar NM: New Mexico in United States
+    :cvar NN: Navajo Nation in United States
+    :cvar NV: Nevada in United States
+    :cvar NY: New York in United States
+    :cvar OH: Ohio in United States
+    :cvar OK: Oklahoma in United States
+    :cvar OR: Oregon in United States
+    :cvar PA: Pennsylvania in United States
+    :cvar PI: Pacific Islands in United States
+    :cvar PR: Puerto Rico in United States
+    :cvar RI: Rhode Island in United States
+    :cvar SC: South Carolina in United States
+    :cvar SD: South Dakota in United States
+    :cvar TN: Tennessee in United States
+    :cvar TT: Trust Territories in United States
+    :cvar TX: Texas in United States
+    :cvar UM: U.S. Minor Outlying Islands in United States
+    :cvar UT: Utah in United States
+    :cvar VA: Virginia in United States
+    :cvar VI: Virgin Islands of the U.S. in United States
+    :cvar VT: Vermont in United States
+    :cvar WA: Washington in United States
+    :cvar WI: Wisconsin in United States
+    :cvar WQ: Wake Island in United States
+    :cvar WV: West Virginia in United States
+    :cvar WY: Wyoming in United States
+    :cvar AB: Alberta province in Canada
+    :cvar BC: British Columbia province in Canada
+    :cvar MB: Manitoba province in Canada
+    :cvar NB: New Brunswick province in Canada
+    :cvar NL: Newfoundland and Labrador province in Canada
+    :cvar NS: Nova Scotia province in Canada
+    :cvar NT: Northwest Territories province in Canada
+    :cvar NU: Nunavut province in Canada
+    :cvar ON: Ontario province in Canada
+    :cvar PE: Prince Edward Island province in Canada
+    :cvar QC: Quebec province in Canada
+    :cvar SK: Saskatchewan province in Canada
+    :cvar YT: Yukon province in Canada
+    """
+
+    AK = "AK"
+    AL = "AL"
+    AR = "AR"
+    AS = "AS"
+    AZ = "AZ"
+    CA = "CA"
+    CO = "CO"
+    CT = "CT"
+    DC = "DC"
+    DE = "DE"
+    FL = "FL"
+    GA = "GA"
+    GU = "GU"
+    HI = "HI"
+    IA = "IA"
+    ID = "ID"
+    IL = "IL"
+    IN = "IN"
+    KS = "KS"
+    KY = "KY"
+    LA = "LA"
+    MA = "MA"
+    MD = "MD"
+    ME = "ME"
+    MH = "MH"
+    MI = "MI"
+    MN = "MN"
+    MO = "MO"
+    MP = "MP"
+    MS = "MS"
+    MT = "MT"
+    NC = "NC"
+    ND = "ND"
+    NE = "NE"
+    NH = "NH"
+    NJ = "NJ"
+    NM = "NM"
+    NN = "NN"
+    NV = "NV"
+    NY = "NY"
+    OH = "OH"
+    OK = "OK"
+    OR = "OR"
+    PA = "PA"
+    PI = "PI"
+    PR = "PR"
+    RI = "RI"
+    SC = "SC"
+    SD = "SD"
+    TN = "TN"
+    TT = "TT"
+    TX = "TX"
+    UM = "UM"
+    UT = "UT"
+    VA = "VA"
+    VI = "VI"
+    VT = "VT"
+    WA = "WA"
+    WI = "WI"
+    WQ = "WQ"
+    WV = "WV"
+    WY = "WY"
+    AB = "AB"
+    BC = "BC"
+    MB = "MB"
+    NB = "NB"
+    NL = "NL"
+    NS = "NS"
+    NT = "NT"
+    NU = "NU"
+    ON = "ON"
+    PE = "PE"
+    QC = "QC"
+    SK = "SK"
+    YT = "YT"

epa_pm_api_wrapper/models/adult_education.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from .other_type import OtherType
+
+
+@dataclass(kw_only=True)
+class AdultEducation(OtherType):
+    """
+    Buildings used primarily for providing adult students with continuing
+    education, workforce development, or professional development outside
+    of the college or university setting.
+    """
+
+    class Meta:
+        name = "adultEducation"

epa_pm_api_wrapper/models/agency_type.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .agency_type_country import AgencyTypeCountry
+
+
+@dataclass(kw_only=True)
+class AgencyType:
+    """
+    :ivar id: The ID created within Portfolio Manager that uniquely
+        defines the federal agency.
+    :ivar code: The federal agency code or abbreviation.
+    :ivar name: The federal agency name.
+    :ivar country: The country which owns this agency.
+    """
+
+    id: None | int = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    code: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    name: None | str = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )
+    country: None | AgencyTypeCountry = field(
+        default=None,
+        metadata={
+            "type": "Attribute",
+        },
+    )