feat(api): update via SDK Studio (#233)

Author: stainless-app[bot]

README.md

@@ -352,13 +352,12 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 - Additional [advanced](https://www.python-httpx.org/advanced/#client-instances) functionality
 
 ```python
-import httpx
-from cloudflare import Cloudflare
+from cloudflare import Cloudflare, DefaultHttpxClient
 
 client = Cloudflare(
     # Or use the `CLOUDFLARE_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
-    http_client=httpx.Client(
+    http_client=DefaultHttpxClient(
         proxies="http://my.test.proxy.example.com",
         transport=httpx.HTTPTransport(local_address="0.0.0.0"),
     ),

api.md

@@ -34,6 +34,7 @@
     UnprocessableEntityError,
     APIResponseValidationError,
 )
+from ._base_client import DefaultHttpxClient, DefaultAsyncHttpxClient
 from ._utils._logs import setup_logging as _setup_logging
 
 __all__ = [
@@ -72,6 +73,8 @@
     "DEFAULT_TIMEOUT",
     "DEFAULT_MAX_RETRIES",
     "DEFAULT_CONNECTION_LIMITS",
+    "DefaultHttpxClient",
+    "DefaultAsyncHttpxClient",
 ]
 
 _setup_logging()

src/cloudflare/__init__.py

@@ -715,7 +715,27 @@ def _idempotency_key(self) -> str:
         return f"stainless-python-retry-{uuid.uuid4()}"
 
 
-class SyncHttpxClientWrapper(httpx.Client):
+class _DefaultHttpxClient(httpx.Client):
+    def __init__(self, **kwargs: Any) -> None:
+        kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+        kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)
+
+
+if TYPE_CHECKING:
+    DefaultHttpxClient = httpx.Client
+    """An alias to `httpx.Client` that provides the same defaults that this SDK
+    uses internally.
+
+    This is useful because overriding the `http_client` with your own instance of
+    `httpx.Client` will result in httpx's defaults being used, not ours.
+    """
+else:
+    DefaultHttpxClient = _DefaultHttpxClient
+
+
+class SyncHttpxClientWrapper(DefaultHttpxClient):
     def __del__(self) -> None:
         try:
             self.close()
@@ -1248,7 +1268,27 @@ def get_api_list(
         return self._request_api_list(model, page, opts)
 
 
-class AsyncHttpxClientWrapper(httpx.AsyncClient):
+class _DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: Any) -> None:
+        kwargs.setdefault("timeout", DEFAULT_TIMEOUT)
+        kwargs.setdefault("limits", DEFAULT_CONNECTION_LIMITS)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)
+
+
+if TYPE_CHECKING:
+    DefaultAsyncHttpxClient = httpx.AsyncClient
+    """An alias to `httpx.AsyncClient` that provides the same defaults that this SDK
+    uses internally.
+
+    This is useful because overriding the `http_client` with your own instance of
+    `httpx.AsyncClient` will result in httpx's defaults being used, not ours.
+    """
+else:
+    DefaultAsyncHttpxClient = _DefaultAsyncHttpxClient
+
+
+class AsyncHttpxClientWrapper(DefaultAsyncHttpxClient):
     def __del__(self) -> None:
         try:
             # TODO(someday): support non asyncio runtimes here

src/cloudflare/_base_client.py

@@ -51,7 +51,7 @@ class Cloudflare(SyncAPIClient):
     origin_ca_certificates: resources.OriginCACertificates
     ips: resources.IPs
     memberships: resources.Memberships
-    user: resources.UserResource
+    user: resources.User
     zones: resources.Zones
     load_balancers: resources.LoadBalancers
     cache: resources.Cache
@@ -108,7 +108,7 @@ class Cloudflare(SyncAPIClient):
     storage: resources.Storage
     stream: resources.Stream
     alerting: resources.Alerting
-    d1: resources.D1
+    d1: resources.D1Resource
     r2: resources.R2
     warp_connector: resources.WARPConnector
     workers_for_platforms: resources.WorkersForPlatforms
@@ -148,7 +148,9 @@ def __init__(
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
-        # Configure a custom httpx client. See the [httpx documentation](https://www.python-httpx.org/api/#client) for more details.
+        # Configure a custom httpx client.
+        # We provide a `DefaultHttpxClient` class that you can pass to retain the default values we use for `limits`, `timeout` & `follow_redirects`.
+        # See the [httpx documentation](https://www.python-httpx.org/api/#client) for more details.
         http_client: httpx.Client | None = None,
         # Enable or disable schema validation for data returned by the API.
         # When enabled an error APIResponseValidationError is raised
@@ -204,7 +206,7 @@ def __init__(
         self.origin_ca_certificates = resources.OriginCACertificates(self)
         self.ips = resources.IPs(self)
         self.memberships = resources.Memberships(self)
-        self.user = resources.UserResource(self)
+        self.user = resources.User(self)
         self.zones = resources.Zones(self)
         self.load_balancers = resources.LoadBalancers(self)
         self.cache = resources.Cache(self)
@@ -261,7 +263,7 @@ def __init__(
         self.storage = resources.Storage(self)
         self.stream = resources.Stream(self)
         self.alerting = resources.Alerting(self)
-        self.d1 = resources.D1(self)
+        self.d1 = resources.D1Resource(self)
         self.r2 = resources.R2(self)
         self.warp_connector = resources.WARPConnector(self)
         self.workers_for_platforms = resources.WorkersForPlatforms(self)
@@ -462,7 +464,7 @@ class AsyncCloudflare(AsyncAPIClient):
     origin_ca_certificates: resources.AsyncOriginCACertificates
     ips: resources.AsyncIPs
     memberships: resources.AsyncMemberships
-    user: resources.AsyncUserResource
+    user: resources.AsyncUser
     zones: resources.AsyncZones
     load_balancers: resources.AsyncLoadBalancers
     cache: resources.AsyncCache
@@ -519,7 +521,7 @@ class AsyncCloudflare(AsyncAPIClient):
     storage: resources.AsyncStorage
     stream: resources.AsyncStream
     alerting: resources.AsyncAlerting
-    d1: resources.AsyncD1
+    d1: resources.AsyncD1Resource
     r2: resources.AsyncR2
     warp_connector: resources.AsyncWARPConnector
     workers_for_platforms: resources.AsyncWorkersForPlatforms
@@ -559,7 +561,9 @@ def __init__(
         max_retries: int = DEFAULT_MAX_RETRIES,
         default_headers: Mapping[str, str] | None = None,
         default_query: Mapping[str, object] | None = None,
-        # Configure a custom httpx client. See the [httpx documentation](https://www.python-httpx.org/api/#asyncclient) for more details.
+        # Configure a custom httpx client.
+        # We provide a `DefaultAsyncHttpxClient` class that you can pass to retain the default values we use for `limits`, `timeout` & `follow_redirects`.
+        # See the [httpx documentation](https://www.python-httpx.org/api/#asyncclient) for more details.
         http_client: httpx.AsyncClient | None = None,
         # Enable or disable schema validation for data returned by the API.
         # When enabled an error APIResponseValidationError is raised
@@ -615,7 +619,7 @@ def __init__(
         self.origin_ca_certificates = resources.AsyncOriginCACertificates(self)
         self.ips = resources.AsyncIPs(self)
         self.memberships = resources.AsyncMemberships(self)
-        self.user = resources.AsyncUserResource(self)
+        self.user = resources.AsyncUser(self)
         self.zones = resources.AsyncZones(self)
         self.load_balancers = resources.AsyncLoadBalancers(self)
         self.cache = resources.AsyncCache(self)
@@ -672,7 +676,7 @@ def __init__(
         self.storage = resources.AsyncStorage(self)
         self.stream = resources.AsyncStream(self)
         self.alerting = resources.AsyncAlerting(self)
-        self.d1 = resources.AsyncD1(self)
+        self.d1 = resources.AsyncD1Resource(self)
         self.r2 = resources.AsyncR2(self)
         self.warp_connector = resources.AsyncWARPConnector(self)
         self.workers_for_platforms = resources.AsyncWorkersForPlatforms(self)
@@ -874,7 +878,7 @@ def __init__(self, client: Cloudflare) -> None:
         self.origin_ca_certificates = resources.OriginCACertificatesWithRawResponse(client.origin_ca_certificates)
         self.ips = resources.IPsWithRawResponse(client.ips)
         self.memberships = resources.MembershipsWithRawResponse(client.memberships)
-        self.user = resources.UserResourceWithRawResponse(client.user)
+        self.user = resources.UserWithRawResponse(client.user)
         self.zones = resources.ZonesWithRawResponse(client.zones)
         self.load_balancers = resources.LoadBalancersWithRawResponse(client.load_balancers)
         self.cache = resources.CacheWithRawResponse(client.cache)
@@ -931,7 +935,7 @@ def __init__(self, client: Cloudflare) -> None:
         self.storage = resources.StorageWithRawResponse(client.storage)
         self.stream = resources.StreamWithRawResponse(client.stream)
         self.alerting = resources.AlertingWithRawResponse(client.alerting)
-        self.d1 = resources.D1WithRawResponse(client.d1)
+        self.d1 = resources.D1ResourceWithRawResponse(client.d1)
         self.r2 = resources.R2WithRawResponse(client.r2)
         self.warp_connector = resources.WARPConnectorWithRawResponse(client.warp_connector)
         self.workers_for_platforms = resources.WorkersForPlatformsWithRawResponse(client.workers_for_platforms)
@@ -960,7 +964,7 @@ def __init__(self, client: AsyncCloudflare) -> None:
         self.origin_ca_certificates = resources.AsyncOriginCACertificatesWithRawResponse(client.origin_ca_certificates)
         self.ips = resources.AsyncIPsWithRawResponse(client.ips)
         self.memberships = resources.AsyncMembershipsWithRawResponse(client.memberships)
-        self.user = resources.AsyncUserResourceWithRawResponse(client.user)
+        self.user = resources.AsyncUserWithRawResponse(client.user)
         self.zones = resources.AsyncZonesWithRawResponse(client.zones)
         self.load_balancers = resources.AsyncLoadBalancersWithRawResponse(client.load_balancers)
         self.cache = resources.AsyncCacheWithRawResponse(client.cache)
@@ -1021,7 +1025,7 @@ def __init__(self, client: AsyncCloudflare) -> None:
         self.storage = resources.AsyncStorageWithRawResponse(client.storage)
         self.stream = resources.AsyncStreamWithRawResponse(client.stream)
         self.alerting = resources.AsyncAlertingWithRawResponse(client.alerting)
-        self.d1 = resources.AsyncD1WithRawResponse(client.d1)
+        self.d1 = resources.AsyncD1ResourceWithRawResponse(client.d1)
         self.r2 = resources.AsyncR2WithRawResponse(client.r2)
         self.warp_connector = resources.AsyncWARPConnectorWithRawResponse(client.warp_connector)
         self.workers_for_platforms = resources.AsyncWorkersForPlatformsWithRawResponse(client.workers_for_platforms)
@@ -1050,7 +1054,7 @@ def __init__(self, client: Cloudflare) -> None:
         self.origin_ca_certificates = resources.OriginCACertificatesWithStreamingResponse(client.origin_ca_certificates)
         self.ips = resources.IPsWithStreamingResponse(client.ips)
         self.memberships = resources.MembershipsWithStreamingResponse(client.memberships)
-        self.user = resources.UserResourceWithStreamingResponse(client.user)
+        self.user = resources.UserWithStreamingResponse(client.user)
         self.zones = resources.ZonesWithStreamingResponse(client.zones)
         self.load_balancers = resources.LoadBalancersWithStreamingResponse(client.load_balancers)
         self.cache = resources.CacheWithStreamingResponse(client.cache)
@@ -1111,7 +1115,7 @@ def __init__(self, client: Cloudflare) -> None:
         self.storage = resources.StorageWithStreamingResponse(client.storage)
         self.stream = resources.StreamWithStreamingResponse(client.stream)
         self.alerting = resources.AlertingWithStreamingResponse(client.alerting)
-        self.d1 = resources.D1WithStreamingResponse(client.d1)
+        self.d1 = resources.D1ResourceWithStreamingResponse(client.d1)
         self.r2 = resources.R2WithStreamingResponse(client.r2)
         self.warp_connector = resources.WARPConnectorWithStreamingResponse(client.warp_connector)
         self.workers_for_platforms = resources.WorkersForPlatformsWithStreamingResponse(client.workers_for_platforms)
@@ -1142,7 +1146,7 @@ def __init__(self, client: AsyncCloudflare) -> None:
         )
         self.ips = resources.AsyncIPsWithStreamingResponse(client.ips)
         self.memberships = resources.AsyncMembershipsWithStreamingResponse(client.memberships)
-        self.user = resources.AsyncUserResourceWithStreamingResponse(client.user)
+        self.user = resources.AsyncUserWithStreamingResponse(client.user)
         self.zones = resources.AsyncZonesWithStreamingResponse(client.zones)
         self.load_balancers = resources.AsyncLoadBalancersWithStreamingResponse(client.load_balancers)
         self.cache = resources.AsyncCacheWithStreamingResponse(client.cache)
@@ -1205,7 +1209,7 @@ def __init__(self, client: AsyncCloudflare) -> None:
         self.storage = resources.AsyncStorageWithStreamingResponse(client.storage)
         self.stream = resources.AsyncStreamWithStreamingResponse(client.stream)
         self.alerting = resources.AsyncAlertingWithStreamingResponse(client.alerting)
-        self.d1 = resources.AsyncD1WithStreamingResponse(client.d1)
+        self.d1 = resources.AsyncD1ResourceWithStreamingResponse(client.d1)
         self.r2 = resources.AsyncR2WithStreamingResponse(client.r2)
         self.warp_connector = resources.AsyncWARPConnectorWithStreamingResponse(client.warp_connector)
         self.workers_for_platforms = resources.AsyncWorkersForPlatformsWithStreamingResponse(

src/cloudflare/_client.py

@@ -1,12 +1,12 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from .d1 import (
-    D1,
-    AsyncD1,
-    D1WithRawResponse,
-    AsyncD1WithRawResponse,
-    D1WithStreamingResponse,
-    AsyncD1WithStreamingResponse,
+    D1Resource,
+    AsyncD1Resource,
+    D1ResourceWithRawResponse,
+    AsyncD1ResourceWithRawResponse,
+    D1ResourceWithStreamingResponse,
+    AsyncD1ResourceWithStreamingResponse,
 )
 from .kv import (
     KV,
@@ -81,12 +81,12 @@
     AsyncLogsWithStreamingResponse,
 )
 from .user import (
-    UserResource,
-    AsyncUserResource,
-    UserResourceWithRawResponse,
-    AsyncUserResourceWithRawResponse,
-    UserResourceWithStreamingResponse,
-    AsyncUserResourceWithStreamingResponse,
+    User,
+    AsyncUser,
+    UserWithRawResponse,
+    AsyncUserWithRawResponse,
+    UserWithStreamingResponse,
+    AsyncUserWithStreamingResponse,
 )
 from .web3 import (
     Web3,
@@ -666,12 +666,12 @@
     "AsyncMembershipsWithRawResponse",
     "MembershipsWithStreamingResponse",
     "AsyncMembershipsWithStreamingResponse",
-    "UserResource",
-    "AsyncUserResource",
-    "UserResourceWithRawResponse",
-    "AsyncUserResourceWithRawResponse",
-    "UserResourceWithStreamingResponse",
-    "AsyncUserResourceWithStreamingResponse",
+    "User",
+    "AsyncUser",
+    "UserWithRawResponse",
+    "AsyncUserWithRawResponse",
+    "UserWithStreamingResponse",
+    "AsyncUserWithStreamingResponse",
     "Zones",
     "AsyncZones",
     "ZonesWithRawResponse",
@@ -1008,12 +1008,12 @@
     "AsyncAlertingWithRawResponse",
     "AlertingWithStreamingResponse",
     "AsyncAlertingWithStreamingResponse",
-    "D1",
-    "AsyncD1",
-    "D1WithRawResponse",
-    "AsyncD1WithRawResponse",
-    "D1WithStreamingResponse",
-    "AsyncD1WithStreamingResponse",
+    "D1Resource",
+    "AsyncD1Resource",
+    "D1ResourceWithRawResponse",
+    "AsyncD1ResourceWithRawResponse",
+    "D1ResourceWithStreamingResponse",
+    "AsyncD1ResourceWithStreamingResponse",
     "R2",
     "AsyncR2",
     "R2WithRawResponse",

src/cloudflare/resources/__init__.py

@@ -28,9 +28,10 @@
 )
 from ...types.accounts import (
     Member,
-    MemberWithCode,
+    MemberRoleParam,
     MemberListResponse,
     MemberDeleteResponse,
+    MemberWithInviteCode,
     member_list_params,
     member_create_params,
     member_delete_params,
@@ -62,7 +63,7 @@ def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> MemberWithCode:
+    ) -> MemberWithInviteCode:
         """
         Add a user to the list of members for this account.
 
@@ -96,15 +97,15 @@ def create(
                 timeout=timeout,
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[MemberWithCode], ResultWrapper[MemberWithCode]),
+            cast_to=cast(Type[MemberWithInviteCode], ResultWrapper[MemberWithInviteCode]),
         )
 
     def update(
         self,
         member_id: str,
         *,
         account_id: object,
-        roles: Iterable[member_update_params.Role],
+        roles: Iterable[MemberRoleParam],
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -308,7 +309,7 @@ async def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> MemberWithCode:
+    ) -> MemberWithInviteCode:
         """
         Add a user to the list of members for this account.
 
@@ -342,15 +343,15 @@ async def create(
                 timeout=timeout,
                 post_parser=ResultWrapper._unwrapper,
             ),
-            cast_to=cast(Type[MemberWithCode], ResultWrapper[MemberWithCode]),
+            cast_to=cast(Type[MemberWithInviteCode], ResultWrapper[MemberWithInviteCode]),
         )
 
     async def update(
         self,
         member_id: str,
         *,
         account_id: object,
-        roles: Iterable[member_update_params.Role],
+        roles: Iterable[MemberRoleParam],
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,