python-frank-energie 5.2.0__tar.gz → 6.0.0__tar.gz

{python_frank_energie-5.2.0 → python_frank_energie-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-frank-energie
-Version: 5.2.0
+Version: 6.0.0
 Summary: Asynchronous Python client for the Frank Energie
 Home-page: https://github.com/dcsbl/python-frank-energie
 License: Apache-2.0
@@ -15,6 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: PyJWT (>=2.8.0)
 Requires-Dist: aiohttp (>=3.8.0)
 Requires-Dist: python-dateutil (>=2.8.0)
+Requires-Dist: syrupy (>=4.6.1,<5.0.0)
 Project-URL: Bug Tracker, https://github.com/dcsbl/python-frank-energie/issues
 Project-URL: Changelog, https://github.com/dcsbl/python-frank-energie/releases
 Project-URL: Documentation, https://github.com/dcsbl/python-frank-energie

{python_frank_energie-5.2.0 → python_frank_energie-6.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-frank-energie"
-version = "5.2.0"
+version = "6.0.0"
 description = "Asynchronous Python client for the Frank Energie"
 authors = ["DCSBL"]
 maintainers = ["DCSBL"]
@@ -20,6 +20,7 @@ python = "^3.10"
 aiohttp = ">=3.8.0"
 python-dateutil = ">=2.8.0"
 PyJWT = ">=2.8.0"
+syrupy = "^4.6.1"
 
 [tool.poetry.dev-dependencies]
 aresponses = "^2.1.6"
@@ -27,27 +28,27 @@ black = "^22.12"
 blacken-docs = "^1.15.0"
 flake8 = "^4.0.1"
 flake8-docstrings = "^1.5.0"
-isort = "^5.11.4"
-pre-commit = "^3.3.2"
+isort = "^5.13.2"
+pre-commit = "^3.6.0"
 pre-commit-hooks = "^4.4.0"
-pylint = "^3.0.2"
-pytest = "^7.4.0"
-pytest-asyncio = "^0.21.0"
+pylint = "^3.0.3"
+pytest = "^7.4.4"
+pytest-asyncio = "^0.23.4"
 pytest-cov = "^4.1.0"
 pyupgrade = "^3.9.0"
-flake8-simplify = "^0.20.0"
-vulture = "^2.7"
+flake8-simplify = "^0.21.0"
+vulture = "^2.11"
 flake8-bandit = "^3.0.0"
 flake8-bugbear = "^23.3.12"
 flake8-builtins = "^2.1.0"
 flake8-comprehensions = "^3.14.0"
 flake8-eradicate = "^1.2.1"
 flake8-markdown = "^0.3.0"
-freezegun = "^1.2.2"
+freezegun = "^1.4.0"
 darglint = "^1.8.1"
-safety = "^2.3.5"
+safety = "^3.0.1"
 codespell = "^2.2.5"
-bandit = "^1.7.3"
+bandit = "^1.7.7"
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/dcsbl/python-frank-energie/issues"

{python_frank_energie-5.2.0 → python_frank_energie-6.0.0}/python_frank_energie/frank_energie.py

@@ -9,7 +9,7 @@ from typing import Any
 from aiohttp.client import ClientError, ClientSession
 
 from .exceptions import AuthException, AuthRequiredException
-from .models import Authentication, Invoices, MarketPrices, MonthSummary, User
+from .models import Authentication, Invoices, MarketPrices, Me, MonthSummary
 
 
 class FrankEnergie:
@@ -100,15 +100,30 @@ class FrankEnergie:
         self._auth = Authentication.from_dict(await self._query(query))
         return self._auth
 
-    async def month_summary(self) -> MonthSummary:
-        """Get month summary data."""
+    async def month_summary(self, site_reference: str) -> MonthSummary:
+        """Get month summary data.
+
+        Returns a MonthSummary object, containing the actual and expected costs until the last meter reading date.
+
+        Full query:
+        query MonthSummary($siteReference: String!) {
+            monthSummary(siteReference: $siteReference) {
+                _id
+                lastMeterReadingDate
+                expectedCostsUntilLastMeterReadingDate
+                actualCostsUntilLastMeterReadingDate
+                meterReadingDayCompleteness
+                gasExcluded
+            }
+        }
+        """
         if self._auth is None:
             raise AuthRequiredException
 
         query = {
             "query": """
-                query MonthSummary {
-                    monthSummary {
+                query MonthSummary($siteReference: String!) {
+                    monthSummary(siteReference: $siteReference) {
                         actualCostsUntilLastMeterReadingDate
                         expectedCostsUntilLastMeterReadingDate
                         expectedCosts
@@ -117,23 +132,60 @@ class FrankEnergie:
                 }
             """,
             "operationName": "MonthSummary",
-            "variables": {},
+            "variables": {"siteReference": site_reference},
         }
 
         return MonthSummary.from_dict(await self._query(query))
 
-    async def invoices(self) -> Invoices:
+    async def invoices(self, site_reference: str) -> Invoices:
         """Get invoices data.
 
         Returns a Invoices object, containing the previous, current and upcoming invoice.
+
+        Full query:
+        query Invoices($siteReference: String!) {
+            invoices(siteReference: $siteReference) {
+                _id
+                previousPeriodInvoice {
+                id
+                StartDate
+                PeriodDescription
+                TotalAmount
+                __typename
+                }
+                currentPeriodInvoice {
+                id
+                StartDate
+                PeriodDescription
+                TotalAmount
+                __typename
+                }
+                upcomingPeriodInvoice {
+                id
+                StartDate
+                PeriodDescription
+                TotalAmount
+                __typename
+                }
+                allInvoices {
+                id
+                StartDate
+                PeriodDescription
+                TotalAmount
+                __typename
+                }
+                __typename
+            }
+        }
+
         """
         if self._auth is None:
             raise AuthRequiredException
 
         query = {
             "query": """
-                query Invoices {
-                    invoices {
+                query Invoices($siteReference: String!) {
+                    invoices(siteReference: $siteReference) {
                         previousPeriodInvoice {
                             StartDate
                             PeriodDescription
@@ -153,38 +205,187 @@ class FrankEnergie:
                 }
             """,
             "operationName": "Invoices",
-            "variables": {},
+            "variables": {"siteReference": site_reference},
         }
 
         return Invoices.from_dict(await self._query(query))
 
-    async def user(self) -> User:
-        """Get user data."""
+    async def me(self, site_reference: str | None = None) -> Me:
+        """Get 'Me' data.
+
+        Full query:
+        query Me($siteReference: String) {
+            me {
+                ...UserFields
+            }
+        }
+        fragment UserFields on User {
+            id
+            email
+            countryCode
+            advancedPaymentAmount(siteReference: $siteReference)
+            treesCount
+            hasInviteLink
+            hasCO2Compensation
+            notification
+            createdAt
+            InviteLinkUser {
+                id
+                fromName
+                slug
+                treesAmountPerConnection
+                discountPerConnection
+            }
+            connections(siteReference: $siteReference) {
+                id
+                connectionId
+                EAN
+                segment
+                status
+                contractStatus
+                estimatedFeedIn
+                firstMeterReadingDate
+                lastMeterReadingDate
+                meterType
+                externalDetails {
+                    gridOperator
+                    address {
+                        street
+                        houseNumber
+                        houseNumberAddition
+                        zipCode
+                        city
+                    }
+                }
+            }
+            externalDetails {
+                reference
+                person {
+                    firstName
+                    lastName
+                }
+                contact {
+                    emailAddress
+                    phoneNumber
+                    mobileNumber
+                }
+                address {
+                    street
+                    houseNumber
+                    houseNumberAddition
+                    zipCode
+                    city
+                }
+                debtor {
+                    bankAccountNumber
+                    preferredAutomaticCollectionDay
+                }
+            }
+            PushNotificationPriceAlerts {
+                id
+                isEnabled
+                type
+                weekdays
+            }
+            UserSettings {
+                id
+                disabledHapticFeedback
+                jedlixUserId
+                jedlixPushNotifications
+                smartPushNotifications
+            }
+            activePaymentAuthorization {
+                id
+                mandateId
+                signedAt
+                bankAccountNumber
+            }
+            meterReadingExportPeriods(siteReference: $siteReference) {
+                EAN
+                cluster
+                segment
+                from
+                till
+                period
+                type
+            }
+            deliverySites {
+                reference
+                segments
+                address {
+                    street
+                    houseNumber
+                    houseNumberAddition
+                    zipCode
+                    city
+                }
+                addressHasMultipleSites
+                status
+                propositionType
+                deliveryStartDate
+                deliveryEndDate
+                firstMeterReadingDate
+                lastMeterReadingDate
+            }
+            smartCharging {
+                isActivated
+                provider
+                userCreatedAt
+                userId
+                isAvailableInCountry
+                needsSubscription
+                subscription {
+                    startDate
+                    endDate
+                    id
+                    proposition {
+                        product
+                        countryCode
+                    }
+                }
+            }
+            websiteUrl
+            customerSupportEmail
+            }
+
+        """
         if self._auth is None:
             raise AuthRequiredException
 
         query = {
             "query": """
-                query Me {
+                query Me($siteReference: String) {
                     me {
                         ...UserFields
                     }
                 }
                 fragment UserFields on User {
                     id
-                    connectionsStatus
-                    firstMeterReadingDate
-                    lastMeterReadingDate
-                    advancedPaymentAmount
+                    email
+                    countryCode
+                    advancedPaymentAmount(siteReference: $siteReference)
                     treesCount
+                    hasInviteLink
                     hasCO2Compensation
+                    deliverySites {
+                        reference
+                        segments
+                        address {
+                            street
+                            houseNumber
+                            houseNumberAddition
+                            zipCode
+                            city
+                        }
+                        status
+                    }
                 }
             """,
             "operationName": "Me",
-            "variables": {},
+            "variables": {"siteReference": site_reference},
         }
 
-        return User.from_dict(await self._query(query))
+        return Me.from_dict(await self._query(query))
 
     async def prices(
         self, start_date: date, end_date: date | None = None
@@ -217,15 +418,45 @@ class FrankEnergie:
 
         return MarketPrices.from_dict(await self._query(query_data))
 
-    async def user_prices(self, start_date: date) -> MarketPrices:
-        """Get customer market prices."""
+    async def user_prices(self, start_date: date, site_reference: str) -> MarketPrices:
+        """Get customer market prices.
+
+        Full query:
+        query MarketPrices($date: String!, $siteReference: String!) {
+            customerMarketPrices(date: $date, siteReference: $siteReference) {
+                id
+                electricityPrices {
+                    id
+                    from
+                    till
+                    date
+                    marketPrice
+                    marketPriceTax
+                    consumptionSourcingMarkupPrice
+                    energyTax
+                    perUnit
+                }
+                gasPrices {
+                    id
+                    from
+                    till
+                    date
+                    marketPrice
+                    marketPriceTax
+                    consumptionSourcingMarkupPrice
+                    energyTax
+                    perUnit
+                }
+            }
+        }
+        """
         if self._auth is None:
             raise AuthRequiredException
 
         query_data = {
             "query": """
-                query CustomerMarketPrices($date: String!) {
-                    customerMarketPrices(date: $date) {
+                query MarketPrices($date: String!, $siteReference: String!) {
+                    customerMarketPrices(date: $date, siteReference: $siteReference) {
                         electricityPrices {
                             from
                             till
@@ -245,8 +476,8 @@ class FrankEnergie:
                     }
                 }
             """,
-            "variables": {"date": str(start_date)},
-            "operationName": "CustomerMarketPrices",
+            "variables": {"date": str(start_date), "siteReference": site_reference},
+            "operationName": "MarketPrices",
         }
 
         return MarketPrices.from_userprices_dict(await self._query(query_data))

{python_frank_energie-5.2.0 → python_frank_energie-6.0.0}/python_frank_energie/models.py

@@ -114,18 +114,74 @@ class Invoices:
 
 
 @dataclass
-class User:
-    """User data, including the current status of the connection."""
+class Me:
+    """Me data, including the current status of the connection."""
 
     id: str
-    connectionsStatus: str
-    firstMeterReadingDate: str
-    lastMeterReadingDate: str
+    email: str
+    countryCode: str
     advancedPaymentAmount: float
+    treesCount: int
+    hasInviteLink: bool
     hasCO2Compensation: bool
+    deliverySites: list[DeliverySites]
+
+    @dataclass
+    class DeliverySites:
+        """Delivery sites data, including the address and delivery status.
+
+        {
+            "reference": "1082MK 10",
+            "segments": [
+                "ELECTRICITY",
+                "GAS"
+            ],
+            "address": {
+                "street": "Gustav Mahlerlaan",
+                "houseNumber": "1025",
+                "houseNumberAddition": null,
+                "zipCode": "1082 MK",
+                "city": "AMSTERDAM"
+            },
+            "addressHasMultipleSites": false,
+            "status": "DELIVERY_ENDED",
+            "propositionType": null,
+            "deliveryStartDate": "2023-01-05",
+            "deliveryEndDate": "2024-02-09",
+            "firstMeterReadingDate": "2023-01-05",
+            "lastMeterReadingDate": "2024-02-08"
+        },
+        """
+
+        reference: str
+        segments: list[str]
+        address_street: str
+        address_houseNumber: str
+        address_houseNumberAddition: str | None
+        address_zipCode: str
+        address_city: str
+        status: str
+
+        @staticmethod
+        def from_dict(payload: dict[str, str]) -> Me.DeliverySites:
+            """Parse the response from the me query."""
+            _LOGGER.debug("DeliverySites %s", payload)
+
+            return Me.DeliverySites(
+                reference=payload.get("reference"),
+                segments=payload.get("segments"),
+                address_street=payload.get("address").get("street"),
+                address_houseNumber=payload.get("address").get("houseNumber"),
+                address_houseNumberAddition=payload.get("address").get(
+                    "houseNumberAddition"
+                ),
+                address_zipCode=payload.get("address").get("zipCode"),
+                address_city=payload.get("address").get("city"),
+                status=payload.get("status"),
+            )
 
     @staticmethod
-    def from_dict(data: dict[str, str]) -> User:
+    def from_dict(data: dict[str, str]) -> Me:
         """Parse the response from the me query."""
         _LOGGER.debug("User %s", data)
 
@@ -136,13 +192,18 @@ class User:
         if not payload:
             raise RequestException("Unexpected response")
 
-        return User(
+        return Me(
             id=payload.get("id"),
-            connectionsStatus=payload.get("connectionsStatus"),
-            firstMeterReadingDate=payload.get("firstMeterReadingDate"),
-            lastMeterReadingDate=payload.get("lastMeterReadingDate"),
+            email=payload.get("email"),
+            countryCode=payload.get("countryCode"),
             advancedPaymentAmount=payload.get("advancedPaymentAmount"),
+            treesCount=payload.get("treesCount"),
+            hasInviteLink=payload.get("hasInviteLink"),
             hasCO2Compensation=payload.get("hasCO2Compensation"),
+            deliverySites=[
+                Me.DeliverySites.from_dict(site)
+                for site in payload.get("deliverySites")
+            ],
         )