agentmail-python/src/agentmail/inboxes/metrics/client.py at main · agentmail-to/agentmail-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# This file was auto-generated by Fern from our API Definition.

import typing

from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from ...core.request_options import RequestOptions
from ...metrics.types.descending import Descending
from ...metrics.types.end import End
from ...metrics.types.metric_event_types import MetricEventTypes
from ...metrics.types.metric_limit import MetricLimit
from ...metrics.types.period import Period
from ...metrics.types.query_metrics_response import QueryMetricsResponse
from ...metrics.types.start import Start
from ..types.inbox_id import InboxId
from .raw_client import AsyncRawMetricsClient, RawMetricsClient


class MetricsClient:
    def __init__(self, *, client_wrapper: SyncClientWrapper):
        self._raw_client = RawMetricsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> RawMetricsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        RawMetricsClient
        """
        return self._raw_client

    def query(
        self,
        inbox_id: InboxId,
        *,
        event_types: typing.Optional[MetricEventTypes] = None,
        start: typing.Optional[Start] = None,
        end: typing.Optional[End] = None,
        period: typing.Optional[Period] = None,
        limit: typing.Optional[MetricLimit] = None,
        descending: typing.Optional[Descending] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> QueryMetricsResponse:
        """
        Parameters
        ----------
        inbox_id : InboxId

        event_types : typing.Optional[MetricEventTypes]

        start : typing.Optional[Start]

        end : typing.Optional[End]

        period : typing.Optional[Period]

        limit : typing.Optional[MetricLimit]

        descending : typing.Optional[Descending]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        QueryMetricsResponse

        Examples
        --------
        from agentmail import AgentMail

        client = AgentMail(
            api_key="YOUR_API_KEY",
        )
        client.inboxes.metrics.query(
            inbox_id="inbox_id",
        )
        """
        _response = self._raw_client.query(
            inbox_id,
            event_types=event_types,
            start=start,
            end=end,
            period=period,
            limit=limit,
            descending=descending,
            request_options=request_options,
        )
        return _response.data


class AsyncMetricsClient:
    def __init__(self, *, client_wrapper: AsyncClientWrapper):
        self._raw_client = AsyncRawMetricsClient(client_wrapper=client_wrapper)

    @property
    def with_raw_response(self) -> AsyncRawMetricsClient:
        """
        Retrieves a raw implementation of this client that returns raw responses.

        Returns
        -------
        AsyncRawMetricsClient
        """
        return self._raw_client

    async def query(
        self,
        inbox_id: InboxId,
        *,
        event_types: typing.Optional[MetricEventTypes] = None,
        start: typing.Optional[Start] = None,
        end: typing.Optional[End] = None,
        period: typing.Optional[Period] = None,
        limit: typing.Optional[MetricLimit] = None,
        descending: typing.Optional[Descending] = None,
        request_options: typing.Optional[RequestOptions] = None,
    ) -> QueryMetricsResponse:
        """
        Parameters
        ----------
        inbox_id : InboxId

        event_types : typing.Optional[MetricEventTypes]

        start : typing.Optional[Start]

        end : typing.Optional[End]

        period : typing.Optional[Period]

        limit : typing.Optional[MetricLimit]

        descending : typing.Optional[Descending]

        request_options : typing.Optional[RequestOptions]
            Request-specific configuration.

        Returns
        -------
        QueryMetricsResponse

        Examples
        --------
        import asyncio

        from agentmail import AsyncAgentMail

        client = AsyncAgentMail(
            api_key="YOUR_API_KEY",
        )


        async def main() -> None:
            await client.inboxes.metrics.query(
                inbox_id="inbox_id",
            )


        asyncio.run(main())
        """
        _response = await self._raw_client.query(
            inbox_id,
            event_types=event_types,
            start=start,
            end=end,
            period=period,
            limit=limit,
            descending=descending,
            request_options=request_options,
        )
        return _response.data