Release 0.0.67

Author: fern-api[bot]

README.md

@@ -157,6 +157,24 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg
 an issue first to discuss with us!
 
 On the other hand, contributions to the README are always very welcome!
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from agentmail import AgentMail
+
+client = AgentMail(
+    api_key="YOUR_API_KEY",
+)
+response = client.inboxes.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
 ## Websockets
 
 The SDK supports both sync and async websocket connections for real-time, low-latency communication. Sockets can be created using the `connect` method, which returns a context manager. 

pyproject.toml

@@ -3,7 +3,7 @@ name = "agentmail"
 
 [tool.poetry]
 name = "agentmail"
-version = "0.0.66"
+version = "0.0.67"
 description = ""
 readme = "README.md"
 authors = []

reference.md

@@ -18,7 +18,12 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.inboxes.list()
+response = client.inboxes.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -271,7 +276,12 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.webhooks.list()
+response = client.webhooks.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -527,7 +537,12 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.domains.list()
+response = client.domains.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -766,7 +781,12 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.drafts.list()
+response = client.drafts.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -917,9 +937,14 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.inboxes.drafts.list(
+response = client.inboxes.drafts.list(
     inbox_id="inbox_id",
 )
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -1369,9 +1394,14 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.inboxes.messages.list(
+response = client.inboxes.messages.list(
     inbox_id="inbox_id",
 )
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -2105,9 +2135,14 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.inboxes.threads.list(
+response = client.inboxes.threads.list(
     inbox_id="inbox_id",
 )
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>
@@ -2494,7 +2529,12 @@ from agentmail import AgentMail
 client = AgentMail(
     api_key="YOUR_API_KEY",
 )
-client.threads.list()
+response = client.threads.list()
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
 
 ```
 </dd>

src/agentmail/core/client_wrapper.py

@@ -23,10 +23,10 @@ def __init__(
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "agentmail/0.0.66",
+            "User-Agent": "agentmail/0.0.67",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "agentmail",
-            "X-Fern-SDK-Version": "0.0.66",
+            "X-Fern-SDK-Version": "0.0.67",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_api_key()}"

src/agentmail/domains/client.py

@@ -3,6 +3,7 @@
 import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.pagination import AsyncPager, SyncPager
 from ..core.request_options import RequestOptions
 from ..types.limit import Limit
 from ..types.page_token import PageToken
@@ -11,7 +12,7 @@
 from .types.domain import Domain
 from .types.domain_id import DomainId
 from .types.domain_name import DomainName
-from .types.list_domains_response import ListDomainsResponse
+from .types.domain_summary import DomainSummary
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -38,7 +39,7 @@ def list(
         limit: typing.Optional[Limit] = None,
         page_token: typing.Optional[PageToken] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListDomainsResponse:
+    ) -> SyncPager[DomainSummary]:
         """
         Parameters
         ----------
@@ -51,7 +52,7 @@ def list(
 
         Returns
         -------
-        ListDomainsResponse
+        SyncPager[DomainSummary]
 
         Examples
         --------
@@ -60,10 +61,14 @@ def list(
         client = AgentMail(
             api_key="YOUR_API_KEY",
         )
-        client.domains.list()
+        response = client.domains.list()
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
         """
-        _response = self._raw_client.list(limit=limit, page_token=page_token, request_options=request_options)
-        return _response.data
+        return self._raw_client.list(limit=limit, page_token=page_token, request_options=request_options)
 
     def get(self, domain: DomainId, *, request_options: typing.Optional[RequestOptions] = None) -> Domain:
         """
@@ -179,7 +184,7 @@ async def list(
         limit: typing.Optional[Limit] = None,
         page_token: typing.Optional[PageToken] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> ListDomainsResponse:
+    ) -> AsyncPager[DomainSummary]:
         """
         Parameters
         ----------
@@ -192,7 +197,7 @@ async def list(
 
         Returns
         -------
-        ListDomainsResponse
+        AsyncPager[DomainSummary]
 
         Examples
         --------
@@ -206,13 +211,18 @@ async def list(
 
 
         async def main() -> None:
-            await client.domains.list()
+            response = await client.domains.list()
+            async for item in response:
+                yield item
+
+            # alternatively, you can paginate page-by-page
+            async for page in response.iter_pages():
+                yield page
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.list(limit=limit, page_token=page_token, request_options=request_options)
-        return _response.data
+        return await self._raw_client.list(limit=limit, page_token=page_token, request_options=request_options)
 
     async def get(self, domain: DomainId, *, request_options: typing.Optional[RequestOptions] = None) -> Domain:
         """

src/agentmail/domains/raw_client.py

@@ -7,6 +7,7 @@
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.http_response import AsyncHttpResponse, HttpResponse
 from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pagination import AsyncPager, BaseHttpResponse, SyncPager
 from ..core.request_options import RequestOptions
 from ..core.unchecked_base_model import construct_type
 from ..errors.not_found_error import NotFoundError
@@ -19,6 +20,7 @@
 from .types.domain import Domain
 from .types.domain_id import DomainId
 from .types.domain_name import DomainName
+from .types.domain_summary import DomainSummary
 from .types.list_domains_response import ListDomainsResponse
 
 # this is used as the default value for optional parameters
@@ -35,7 +37,7 @@ def list(
         limit: typing.Optional[Limit] = None,
         page_token: typing.Optional[PageToken] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> HttpResponse[ListDomainsResponse]:
+    ) -> SyncPager[DomainSummary]:
         """
         Parameters
         ----------
@@ -48,7 +50,7 @@ def list(
 
         Returns
         -------
-        HttpResponse[ListDomainsResponse]
+        SyncPager[DomainSummary]
         """
         _response = self._client_wrapper.httpx_client.request(
             "v0/domains",
@@ -62,14 +64,24 @@ def list(
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListDomainsResponse,
                     construct_type(
                         type_=ListDomainsResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return HttpResponse(response=_response, data=_data)
+                _items = _parsed_response.domains
+                _parsed_next = _parsed_response.next_page_token
+                _has_next = _parsed_next is not None and _parsed_next != ""
+                _get_next = lambda: self.list(
+                    limit=limit,
+                    page_token=_parsed_next,
+                    request_options=request_options,
+                )
+                return SyncPager(
+                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
@@ -230,7 +242,7 @@ async def list(
         limit: typing.Optional[Limit] = None,
         page_token: typing.Optional[PageToken] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> AsyncHttpResponse[ListDomainsResponse]:
+    ) -> AsyncPager[DomainSummary]:
         """
         Parameters
         ----------
@@ -243,7 +255,7 @@ async def list(
 
         Returns
         -------
-        AsyncHttpResponse[ListDomainsResponse]
+        AsyncPager[DomainSummary]
         """
         _response = await self._client_wrapper.httpx_client.request(
             "v0/domains",
@@ -257,14 +269,27 @@ async def list(
         )
         try:
             if 200 <= _response.status_code < 300:
-                _data = typing.cast(
+                _parsed_response = typing.cast(
                     ListDomainsResponse,
                     construct_type(
                         type_=ListDomainsResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
-                return AsyncHttpResponse(response=_response, data=_data)
+                _items = _parsed_response.domains
+                _parsed_next = _parsed_response.next_page_token
+                _has_next = _parsed_next is not None and _parsed_next != ""
+
+                async def _get_next():
+                    return await self.list(
+                        limit=limit,
+                        page_token=_parsed_next,
+                        request_options=request_options,
+                    )
+
+                return AsyncPager(
+                    has_next=_has_next, items=_items, get_next=_get_next, response=BaseHttpResponse(response=_response)
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)