Excavator: Upgrade API Version (#201)

Author: svc-excavator-bot

README.md

@@ -4,9 +4,6 @@
 [![PyPI Version](https://img.shields.io/pypi/v/foundry-platform-sdk)](https://pypi.org/project/foundry-platform-sdk/)
 [![License](https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg)](https://opensource.org/licenses/Apache-2.0)
 
-> [!WARNING]
-> This SDK is incubating and subject to change.
-
 The Foundry Platform SDK is a Python SDK built on top of the Foundry API.
 Review [Foundry API documentation](https://www.palantir.com/docs/foundry/api/) for more details.
 
@@ -308,23 +305,95 @@ To iterate over all items, you can simply create a `ResourceIterator` instance a
 for item in client.datasets.Dataset.Branch.list(dataset_rid):
     print(item)
 
+# Or, you can collect all the items in a list
+results = list(client.datasets.Dataset.Branch.list(dataset_rid))
+
 ```
 
 This will automatically fetch and iterate through all the pages of data from the specified API endpoint. For more granular control, you can manually fetch each page using the `next_page_token`.
 
 ```python
-page = client.datasets.Dataset.Branch.list(dataset_rid, page_size=page_size)
-
-while page.next_page_token:
+next_page_token: Optional[str] = None
+while True:
+    page = client.datasets.Dataset.Branch.list(
+        dataset_rid, page_size=page_size, page_token=next_page_token
+    )
     for branch in page.data:
         print(branch)
 
-    page = client.datasets.Dataset.Branch.list(
-        dataset_rid, page_size=page_size, page_token=page.next_page_token
+    if page.next_page_token is None:
+        break
+
+    next_page_token = page.next_page_token
+
+```
+
+### Asynchronous Pagination (Beta)
+
+> [!WARNING]
+> The asynchronous client is in beta and may change in future releases.
+
+When using the `AsyncFoundryClient` client, pagination works similar to the synchronous client
+but you need to use `async for` to iterate over the results. Here's an example:
+
+
+```python
+async for item in client.datasets.Dataset.Branch.list(dataset_rid):
+    print(item)
+
+# Or, you can collect all the items in a list
+results = [item async for item in client.datasets.Dataset.Branch.list(dataset_rid)]
+
+```
+
+For more control over asynchronous pagination, you can manually handle the pagination
+tokens and use the `with_raw_response` utility to fetch each page.
+
+
+```python
+next_page_token: Optional[str] = None
+while True:
+    response = await client.client.datasets.Dataset.Branch.with_raw_response.list(
+        dataset_rid, page_token=next_page_token
     )
 
+    page = response.decode()
+    for item in page.data:
+        print(item)
+
+    if page.next_page_token is None:
+        break
+
+    next_page_token = page.next_page_token
+
+```
+
+<a id="async-client"></a>
+### Asynchronous Client (Beta)
+
+> [!WARNING]
+> The asynchronous client is in beta and may change in future releases.
+
+This SDK supports creating an asynchronous client, just import and instantiate the
+`AsyncFoundryClient` instead of the `FoundryClient`.
+
+```python
+from foundry import AsyncFoundryClient
+import foundry
+import asyncio
+from pprint import pprint
+
+async def main():
+    client = AsyncFoundryClient(...)
+    response = await client.datasets.Dataset.Branch.create(dataset_rid, name=name, transaction_rid=transaction_rid)
+    pprint(response)
+
+if __name__ == "__main__":
+    asyncio.run(main())
 ```
 
+When using asynchronous clients, you'll just need to use the `await` keyword when calling APIs. Otherwise, the behaviour
+between the `FoundryClient` and `AsyncFoundryClient` is nearly identical.
 
 <a id="binary-streaming"></a>
 ## Streaming

changelog/@unreleased/pr-201.v2.yml

@@ -0,0 +1,6 @@
+type: feature
+feature:
+  description: You can now call the Foundry APIs asynchronously using the new `AsyncFoundryClient`
+    client, now available in beta!
+  links:
+  - https://github.com/palantir/foundry-platform-python/pull/201

docs-snippets-npm/package.json

@@ -24,7 +24,7 @@
   "sls": {
     "dependencies": {
       "com.palantir.foundry.api:api-gateway": {
-        "minVersion": "1.1174.0",
+        "minVersion": "1.1175.0",
         "maxVersion": "1.x.x",
         "optional": false
       }

foundry_sdk/__init__.py

@@ -14,6 +14,7 @@
 
 
 from foundry_sdk._core import ApiResponse
+from foundry_sdk._core import AsyncApiResponse
 from foundry_sdk._core import Auth
 from foundry_sdk._core import ConfidentialClientAuth
 from foundry_sdk._core import Config

foundry_sdk/_core/__init__.py

@@ -15,10 +15,14 @@
 
 from foundry_sdk._core.api_client import ApiClient
 from foundry_sdk._core.api_client import ApiResponse
+from foundry_sdk._core.api_client import AsyncApiClient
+from foundry_sdk._core.api_client import AsyncApiResponse
 from foundry_sdk._core.api_client import RequestInfo
 from foundry_sdk._core.api_client import SdkInternal
 from foundry_sdk._core.api_client import StreamedApiResponse
 from foundry_sdk._core.api_client import StreamingContextManager
+from foundry_sdk._core.api_client import async_with_raw_response
+from foundry_sdk._core.api_client import async_with_streaming_response
 from foundry_sdk._core.api_client import with_raw_response
 from foundry_sdk._core.api_client import with_streaming_response
 from foundry_sdk._core.auth_utils import Auth
@@ -27,6 +31,7 @@
 from foundry_sdk._core.confidential_client_auth import ConfidentialClientAuth
 from foundry_sdk._core.config import Config
 from foundry_sdk._core.public_client_auth import PublicClientAuth
+from foundry_sdk._core.resource_iterator import AsyncResourceIterator
 from foundry_sdk._core.resource_iterator import ResourceIterator
 from foundry_sdk._core.user_token_auth_client import UserTokenAuth
 from foundry_sdk._core.utils import RID