Release 0.0.66

Author: fern-api[bot]

README.md

@@ -80,6 +80,14 @@ client = AgentMail(
 response = client.inboxes.with_raw_response.create(...)
 print(response.headers)  # access the response headers
 print(response.data)  # access the underlying object
+pager = client.inboxes.list(...)
+print(pager.response.headers)  # access the response headers for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response.headers)  # access the response headers for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
 ```
 
 ### Retries

pyproject.toml

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

reference.md

@@ -590,7 +590,7 @@ client = AgentMail(
     api_key="YOUR_API_KEY",
 )
 client.domains.get(
-    domain=" your-domain.com",
+    domain="domain",
 )
 
 ```
@@ -646,7 +646,7 @@ client = AgentMail(
     api_key="YOUR_API_KEY",
 )
 client.domains.create(
-    domain="your-domain.com",
+    domain="domain",
 )
 
 ```
@@ -710,7 +710,7 @@ client = AgentMail(
     api_key="YOUR_API_KEY",
 )
 client.domains.delete(
-    domain="dom_12345",
+    domain="domain",
 )
 
 ```

src/agentmail/core/__init__.py

@@ -14,6 +14,7 @@
     from .http_client import AsyncHttpClient, HttpClient
     from .http_response import AsyncHttpResponse, HttpResponse
     from .jsonable_encoder import jsonable_encoder
+    from .pagination import AsyncPager, SyncPager
     from .pydantic_utilities import (
         IS_PYDANTIC_V2,
         UniversalBaseModel,
@@ -33,6 +34,7 @@
     "AsyncClientWrapper": ".client_wrapper",
     "AsyncHttpClient": ".http_client",
     "AsyncHttpResponse": ".http_response",
+    "AsyncPager": ".pagination",
     "BaseClientWrapper": ".client_wrapper",
     "EventEmitterMixin": ".events",
     "EventType": ".events",
@@ -43,6 +45,7 @@
     "IS_PYDANTIC_V2": ".pydantic_utilities",
     "RequestOptions": ".request_options",
     "SyncClientWrapper": ".client_wrapper",
+    "SyncPager": ".pagination",
     "UncheckedBaseModel": ".unchecked_base_model",
     "UnionMetadata": ".unchecked_base_model",
     "UniversalBaseModel": ".pydantic_utilities",
@@ -88,6 +91,7 @@ def __dir__():
     "AsyncClientWrapper",
     "AsyncHttpClient",
     "AsyncHttpResponse",
+    "AsyncPager",
     "BaseClientWrapper",
     "EventEmitterMixin",
     "EventType",
@@ -98,6 +102,7 @@ def __dir__():
     "IS_PYDANTIC_V2",
     "RequestOptions",
     "SyncClientWrapper",
+    "SyncPager",
     "UncheckedBaseModel",
     "UnionMetadata",
     "UniversalBaseModel",

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.60",
+            "User-Agent": "agentmail/0.0.66",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "agentmail",
-            "X-Fern-SDK-Version": "0.0.60",
+            "X-Fern-SDK-Version": "0.0.66",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_api_key()}"

src/agentmail/core/pagination.py

@@ -0,0 +1,82 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import AsyncIterator, Awaitable, Callable, Generic, Iterator, List, Optional, TypeVar
+
+from .http_response import BaseHttpResponse
+
+# Generic to represent the underlying type of the results within a page
+T = TypeVar("T")
+
+
+# SDKs implement a Page ABC per-pagination request, the endpoint then returns a pager that wraps this type
+# for example, an endpoint will return SyncPager[UserPage] where UserPage implements the Page ABC. ex:
+#
+# SyncPager<InnerListType>(
+#     has_next=response.list_metadata.after is not None,
+#     items=response.data,
+#     # This should be the outer function that returns the SyncPager again
+#     get_next=lambda: list(..., cursor: response.cursor) (or list(..., offset: offset + 1))
+# )
+
+
+@dataclass(frozen=True)
+class SyncPager(Generic[T]):
+    get_next: Optional[Callable[[], Optional[SyncPager[T]]]]
+    has_next: bool
+    items: Optional[List[T]]
+    response: Optional[BaseHttpResponse]
+
+    # Here we type ignore the iterator to avoid a mypy error
+    # caused by the type conflict with Pydanitc's __iter__ method
+    # brought in by extending the base model
+    def __iter__(self) -> Iterator[T]:  # type: ignore[override]
+        for page in self.iter_pages():
+            if page.items is not None:
+                yield from page.items
+
+    def iter_pages(self) -> Iterator[SyncPager[T]]:
+        page: Optional[SyncPager[T]] = self
+        while page is not None:
+            yield page
+
+            if not page.has_next or page.get_next is None:
+                return
+
+            page = page.get_next()
+            if page is None or page.items is None or len(page.items) == 0:
+                return
+
+    def next_page(self) -> Optional[SyncPager[T]]:
+        return self.get_next() if self.get_next is not None else None
+
+
+@dataclass(frozen=True)
+class AsyncPager(Generic[T]):
+    get_next: Optional[Callable[[], Awaitable[Optional[AsyncPager[T]]]]]
+    has_next: bool
+    items: Optional[List[T]]
+    response: Optional[BaseHttpResponse]
+
+    async def __aiter__(self) -> AsyncIterator[T]:
+        async for page in self.iter_pages():
+            if page.items is not None:
+                for item in page.items:
+                    yield item
+
+    async def iter_pages(self) -> AsyncIterator[AsyncPager[T]]:
+        page: Optional[AsyncPager[T]] = self
+        while page is not None:
+            yield page
+
+            if not page.has_next or page.get_next is None:
+                return
+
+            page = await page.get_next()
+            if page is None or page.items is None or len(page.items) == 0:
+                return
+
+    async def next_page(self) -> Optional[AsyncPager[T]]:
+        return await self.get_next() if self.get_next is not None else None

src/agentmail/domains/client.py

@@ -86,7 +86,7 @@ def get(self, domain: DomainId, *, request_options: typing.Optional[RequestOptio
             api_key="YOUR_API_KEY",
         )
         client.domains.get(
-            domain=" your-domain.com",
+            domain="domain",
         )
         """
         _response = self._raw_client.get(domain, request_options=request_options)
@@ -122,7 +122,7 @@ def create(
             api_key="YOUR_API_KEY",
         )
         client.domains.create(
-            domain="your-domain.com",
+            domain="domain",
         )
         """
         _response = self._raw_client.create(
@@ -151,7 +151,7 @@ def delete(self, domain: DomainId, *, request_options: typing.Optional[RequestOp
             api_key="YOUR_API_KEY",
         )
         client.domains.delete(
-            domain="dom_12345",
+            domain="domain",
         )
         """
         _response = self._raw_client.delete(domain, request_options=request_options)
@@ -240,7 +240,7 @@ async def get(self, domain: DomainId, *, request_options: typing.Optional[Reques
 
         async def main() -> None:
             await client.domains.get(
-                domain=" your-domain.com",
+                domain="domain",
             )
 
 
@@ -284,7 +284,7 @@ async def create(
 
         async def main() -> None:
             await client.domains.create(
-                domain="your-domain.com",
+                domain="domain",
             )
 
 
@@ -321,7 +321,7 @@ async def delete(self, domain: DomainId, *, request_options: typing.Optional[Req
 
         async def main() -> None:
             await client.domains.delete(
-                domain="dom_12345",
+                domain="domain",
             )