Release 0.0.20

Author: fern-api[bot]

.github/workflows/ci.yml

@@ -3,10 +3,10 @@ name: ci
 on: [push]
 jobs:
   compile:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up python
         uses: actions/setup-python@v4
         with:
@@ -19,10 +19,10 @@ jobs:
       - name: Compile
         run: poetry run mypy .
   test:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up python
         uses: actions/setup-python@v4
         with:
@@ -39,10 +39,10 @@ jobs:
   publish:
     needs: [compile, test]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up python
         uses: actions/setup-python@v4
         with:

.gitignore

@@ -1,5 +1,5 @@
-dist/
 .mypy_cache/
+.ruff_cache/
 __pycache__/
+dist/
 poetry.toml
-.ruff_cache/

README.md

@@ -21,35 +21,20 @@ Instantiate and use the client with the following:
 
 ```python
 from agentmail import AgentMail
-
-client = AgentMail(
-    api_key="YOUR_API_KEY",
-)
-client.inboxes.create(
-    domain="yourdomain.com",
-)
+client = AgentMail(api_key="YOUR_API_KEY", )
+client.inboxes.create(domain='yourdomain.com', )
 ```
 
 ## Async Client
 
 The SDK also exports an `async` client so that you can make non-blocking calls to our API.
 
 ```python
-import asyncio
-
 from agentmail import AsyncAgentMail
-
-client = AsyncAgentMail(
-    api_key="YOUR_API_KEY",
-)
-
-
+import asyncio
+client = AsyncAgentMail(api_key="YOUR_API_KEY", )
 async def main() -> None:
-    await client.inboxes.create(
-        domain="yourdomain.com",
-    )
-
-
+    await client.inboxes.create(domain='yourdomain.com', )
 asyncio.run(main())
 ```
 
@@ -60,7 +45,6 @@ will be thrown.
 
 ```python
 from agentmail.core.api_error import ApiError
-
 try:
     client.inboxes.create(...)
 except ApiError as e:
@@ -70,6 +54,19 @@ except ApiError as e:
 
 ## Advanced
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from agentmail import AgentMail
+client = AgentMail(..., )
+response = client.inboxes.with_raw_response.create(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+```
+
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
@@ -97,12 +94,7 @@ The SDK defaults to a 60 second timeout. You can configure this with a timeout o
 ```python
 
 from agentmail import AgentMail
-
-client = AgentMail(
-    ...,
-    timeout=20.0,
-)
-
+client = AgentMail(..., timeout=20.0, )
 
 # Override timeout for a specific method
 client.inboxes.create(..., request_options={
@@ -114,18 +106,11 @@ client.inboxes.create(..., request_options={
 
 You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
 and transports.
+
 ```python
-import httpx
 from agentmail import AgentMail
-
-client = AgentMail(
-    ...,
-    httpx_client=httpx.Client(
-        proxies="http://my.test.proxy.example.com",
-        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
-    ),
-)
-```
+import httpx
+client = AgentMail(..., httpx_client=httpx.Client(proxies="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0"), ))```
 
 ## Contributing
 

poetry.lock

@@ -40,13 +40,13 @@ pydantic = ">= 1.9.2"
 pydantic-core = "^2.18.2"
 typing_extensions = ">= 4.0.0"
 
-[tool.poetry.dev-dependencies]
-mypy = "1.0.1"
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
 pytest = "^7.4.0"
 pytest-asyncio = "^0.23.5"
 python-dateutil = "^2.9.0"
 types-python-dateutil = "^2.9.0.20240316"
-ruff = "^0.5.6"
+ruff = "==0.11.5"
 
 [tool.pytest.ini_options]
 testpaths = [ "tests" ]
@@ -58,6 +58,26 @@ plugins = ["pydantic.mypy"]
 [tool.ruff]
 line-length = 120
 
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
 
 [build-system]
 requires = ["poetry-core"]