Merge pull request #31 from team-monite/fern-bot/05-06-2025-1226PM

🌿 Fern Regeneration -- May 6, 2025

Author: arthemium

.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

@@ -25,41 +25,21 @@ Instantiate and use the client with the following:
 
 ```python
 from monite import Monite
-
-client = Monite(
-    monite_version="YOUR_MONITE_VERSION",
-    monite_entity_id="YOUR_MONITE_ENTITY_ID",
-    token="YOUR_TOKEN",
-)
-client.products.create(
-    name="name",
-)
+client = Monite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", )
+client.products.create(name='name', )
 ```
 
 ## Async Client
 
 The SDK also exports an `async` client so that you can make non-blocking calls to our API.
 
 ```python
-import asyncio
-
 from monite import AsyncMonite
-
-client = AsyncMonite(
-    monite_version="YOUR_MONITE_VERSION",
-    monite_entity_id="YOUR_MONITE_ENTITY_ID",
-    token="YOUR_TOKEN",
-)
-
-
+import asyncio
+client = AsyncMonite(monite_version="YOUR_MONITE_VERSION", monite_entity_id="YOUR_MONITE_ENTITY_ID", token="YOUR_TOKEN", )
 async def main() -> None:
-    await client.products.create(
-        name="name",
-    )
-
-
-asyncio.run(main())
-```
+    await client.products.create(name='name', )
+asyncio.run(main())```
 
 ## Exception Handling
 
@@ -68,7 +48,6 @@ will be thrown.
 
 ```python
 from monite.core.api_error import ApiError
-
 try:
     client.products.create(...)
 except ApiError as e:
@@ -78,13 +57,26 @@ 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 monite import Monite
+client = Monite(..., )
+response = client.products.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
-as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
 retry limit (default: 2).
 
-A request is deemed retriable when any of the following HTTP status codes is returned:
+A request is deemed retryable when any of the following HTTP status codes is returned:
 
 - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
 - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
@@ -105,12 +97,7 @@ The SDK defaults to a 60 second timeout. You can configure this with a timeout o
 ```python
 
 from monite import Monite
-
-client = Monite(
-    ...,
-    timeout=20.0,
-)
-
+client = Monite(..., timeout=20.0, )
 
 # Override timeout for a specific method
 client.products.create(..., request_options={
@@ -122,18 +109,11 @@ client.products.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 monite import Monite
-
-client = Monite(
-    ...,
-    httpx_client=httpx.Client(
-        proxies="http://my.test.proxy.example.com",
-        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
-    ),
-)
-```
+import httpx
+client = Monite(..., httpx_client=httpx.Client(proxies="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0"), ))```
 
 ## Contributing