|
| 1 | +from typing import Literal |
| 2 | + |
| 3 | +from mailtrap.http import HttpClient |
| 4 | +from mailtrap.models.stats import SendingStatGroup, SendingStats, StatsFilterParams |
| 5 | + |
| 6 | +GroupKey = Literal["domains", "categories", "email_service_providers", "date"] |
| 7 | + |
| 8 | +_GROUP_KEYS = { |
| 9 | + "domains": "sending_domain_id", |
| 10 | + "categories": "category", |
| 11 | + "email_service_providers": "email_service_provider", |
| 12 | + "date": "date", |
| 13 | +} |
| 14 | + |
| 15 | + |
| 16 | +class StatsApi: |
| 17 | + def __init__(self, client: HttpClient) -> None: |
| 18 | + self._client = client |
| 19 | + |
| 20 | + def get(self, account_id: int, params: StatsFilterParams) -> SendingStats: |
| 21 | + """Get aggregated sending stats.""" |
| 22 | + response = self._client.get( |
| 23 | + self._base_path(account_id), |
| 24 | + params=params.api_query_params, |
| 25 | + ) |
| 26 | + return SendingStats(**response) |
| 27 | + |
| 28 | + def by_domain( |
| 29 | + self, account_id: int, params: StatsFilterParams |
| 30 | + ) -> list[SendingStatGroup]: |
| 31 | + """Get sending stats grouped by domains.""" |
| 32 | + return self._grouped_stats(account_id, "domains", params) |
| 33 | + |
| 34 | + def by_category( |
| 35 | + self, account_id: int, params: StatsFilterParams |
| 36 | + ) -> list[SendingStatGroup]: |
| 37 | + """Get sending stats grouped by categories.""" |
| 38 | + return self._grouped_stats(account_id, "categories", params) |
| 39 | + |
| 40 | + def by_email_service_provider( |
| 41 | + self, account_id: int, params: StatsFilterParams |
| 42 | + ) -> list[SendingStatGroup]: |
| 43 | + """Get sending stats grouped by email service providers.""" |
| 44 | + return self._grouped_stats(account_id, "email_service_providers", params) |
| 45 | + |
| 46 | + def by_date( |
| 47 | + self, account_id: int, params: StatsFilterParams |
| 48 | + ) -> list[SendingStatGroup]: |
| 49 | + """Get sending stats grouped by date.""" |
| 50 | + return self._grouped_stats(account_id, "date", params) |
| 51 | + |
| 52 | + def _grouped_stats( |
| 53 | + self, account_id: int, group: GroupKey, params: StatsFilterParams |
| 54 | + ) -> list[SendingStatGroup]: |
| 55 | + response = self._client.get( |
| 56 | + f"{self._base_path(account_id)}/{group}", params=params.api_query_params |
| 57 | + ) |
| 58 | + group_key = _GROUP_KEYS[group] |
| 59 | + |
| 60 | + return [ |
| 61 | + SendingStatGroup( |
| 62 | + name=group_key, |
| 63 | + value=item[group_key], |
| 64 | + stats=SendingStats(**item["stats"]), |
| 65 | + ) |
| 66 | + for item in response |
| 67 | + ] |
| 68 | + |
| 69 | + @staticmethod |
| 70 | + def _base_path(account_id: int) -> str: |
| 71 | + return f"/api/accounts/{account_id}/stats" |
0 commit comments