release: 4.2.0

.github/workflows/ci.yml

@@ -18,7 +18,6 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     timeout-minutes: 5
-
     steps:
       - uses: actions/checkout@v4
 
@@ -40,7 +39,6 @@ jobs:
     name: test
     runs-on: ubuntu-latest
     timeout-minutes: 30
-
     steps:
       - uses: actions/checkout@v4
 
@@ -61,6 +59,7 @@ jobs:
   examples:
     name: examples
     runs-on: ubuntu-latest
+    if: github.repository == 'cloudflare/cloudflare-python'
     timeout-minutes: 5
 
     steps:

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.1.0"
+  ".": "4.2.0"
 }

.stats.yml

@@ -1,2 +1,4 @@
-configured_endpoints: 1655
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-0ed9f898b31619623e50d660d04beca50e44987bfd3eb3a6ff98d3bca2a9c569.yml
+configured_endpoints: 1711
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-2445b18a5453d17bb106dd9e3d672bf2400bc2c67e921797ac410661a13ffef4.yml
+openapi_spec_hash: 1282c2a366839e635aab91b1ec2a3cb3
+config_hash: ea8f45dbac8e2ed462221c2e2781e7ed

README.md

@@ -151,17 +151,16 @@ from cloudflare import Cloudflare
 
 client = Cloudflare()
 
-account = client.accounts.create(
-    name="name",
-    type="standard",
-    unit={"id": "f267e341f3dd4697bd3b9f71dd96247f"},
+zone = client.zones.create(
+    account={"id": "023e105f4ecef8ad9ca31a8372d0c353"},
+    name="example.com",
 )
-print(account.unit)
+print(zone.account)
 ```
 
 ## File uploads
 
-Request parameters that correspond to file uploads can be passed as `bytes`, a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
 
 ```python
 from pathlib import Path

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cloudflare"
-version = "4.1.0"
+version = "4.2.0"
 description = "The official Python library for the cloudflare API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -147,11 +147,10 @@ exclude = [
 ]
 
 reportImplicitOverride = true
+reportOverlappingOverload = false
 
 reportImportCycles = false
 reportPrivateUsage = false
-reportOverlappingOverload = false
-
 
 [tool.ruff]
 line-length = 120

src/cloudflare/_base_client.py

@@ -54,11 +54,13 @@
     PostParser,
     RequestFiles,
     HttpxSendArgs,
+    HttpxFileTypes,
     RequestOptions,
+    MultipartSyntax,
     HttpxRequestFiles,
     ModelBuilderProtocol,
 )
-from ._utils import is_dict, is_list, asyncify, is_given, lru_cache, is_mapping
+from ._utils import is_dict, is_list, asyncify, is_given, is_tuple, lru_cache, is_mapping, is_mapping_t, is_sequence_t
 from ._compat import PYDANTIC_V2, model_copy, model_dump
 from ._models import GenericModel, FinalRequestOptions, validate_type, construct_type
 from ._response import (
@@ -331,6 +333,7 @@ class BaseClient(Generic[_HttpxClientT, _DefaultStreamT]):
     _client: _HttpxClientT
     _version: str
     _base_url: URL
+    _api_version: str
     max_retries: int
     timeout: Union[float, Timeout, None]
     _strict_response_validation: bool
@@ -342,6 +345,7 @@ def __init__(
         *,
         version: str,
         base_url: str | URL,
+        api_version: str,
         _strict_response_validation: bool,
         max_retries: int = DEFAULT_MAX_RETRIES,
         timeout: float | Timeout | None = DEFAULT_TIMEOUT,
@@ -350,6 +354,7 @@ def __init__(
     ) -> None:
         self._version = version
         self._base_url = self._enforce_trailing_slash(URL(base_url))
+        self.api_version = api_version
         self.max_retries = max_retries
         self.timeout = timeout
         self._custom_headers = custom_headers or {}
@@ -409,7 +414,8 @@ def _build_headers(self, options: FinalRequestOptions, *, retries_taken: int = 0
 
         idempotency_header = self._idempotency_header
         if idempotency_header and options.method.lower() != "get" and idempotency_header not in headers:
-            headers[idempotency_header] = options.idempotency_key or self._idempotency_key()
+            options.idempotency_key = options.idempotency_key or self._idempotency_key()
+            headers[idempotency_header] = options.idempotency_key
 
         # Don't set these headers if they were already set or removed by the caller. We check
         # `custom_headers`, which can contain `Omit()`, instead of `headers` to account for the removal case.
@@ -423,6 +429,8 @@ def _build_headers(self, options: FinalRequestOptions, *, retries_taken: int = 0
             if timeout is not None:
                 headers["x-stainless-read-timeout"] = str(timeout)
 
+        headers["api-version"] = self.api_version
+
         return headers
 
     def _prepare_url(self, url: str) -> URL:
@@ -484,7 +492,24 @@ def _build_request(
                     raise TypeError(
                         f"Expected query input to be a dictionary for multipart requests but got {type(json_data)} instead."
                     )
-                kwargs["data"] = self._serialize_multipartform(json_data)
+
+                if options.multipart_syntax == 'json':
+                    json_data = cast("Mapping[str, object]", json_data)
+                    if is_mapping_t(files):
+                        files = {
+                            **files,
+                            **self._serialize_multiapartform_json(json_data),
+                        }
+                    elif is_sequence_t(files):
+                        files = [
+                            *files,
+                            *self._serialize_multiapartform_json(json_data).items(),
+                        ]
+                    else:
+                        assert not files, "this case should only be hit when there are no files"
+                        files = self._serialize_multiapartform_json(json_data)
+                else:
+                    kwargs["data"] = self._serialize_multipartform(json_data)
 
             # httpx determines whether or not to send a "multipart/form-data"
             # request based on the truthiness of the "files" argument.
@@ -516,6 +541,22 @@ def _build_request(
             **kwargs,
         )
 
+    def _serialize_multiapartform_json(self, data: Mapping[str, object]) -> dict[str, HttpxFileTypes]:
+        serialized: dict[str, HttpxFileTypes] = {}
+        for key, value in data.items():
+            if isinstance(value, Mapping) or is_list(value) or is_tuple(value):
+                serialized[key] = (None, json.dumps(value).encode("utf-8"), "application/json")
+            else:
+                serialized[key] = (
+                    None,
+                    self.qs._primitive_value_to_str(
+                        value  # type: ignore
+                    ).encode("utf-8"),
+                    "text/plain",
+                )
+
+        return serialized
+
     def _serialize_multipartform(self, data: Mapping[object, object]) -> dict[str, object]:
         items = self.qs.stringify_items(
             # TODO: type ignore is required as stringify_items is well typed but we can't be
@@ -785,6 +826,7 @@ def __init__(
         *,
         version: str,
         base_url: str | URL,
+        api_version: str,
         max_retries: int = DEFAULT_MAX_RETRIES,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -815,6 +857,7 @@ def __init__(
             # cast to a valid type because mypy doesn't understand our type narrowing
             timeout=cast(Timeout, timeout),
             base_url=base_url,
+            api_version=api_version,
             max_retries=max_retries,
             custom_query=custom_query,
             custom_headers=custom_headers,
@@ -943,6 +986,10 @@ def _request(
         request = self._build_request(options, retries_taken=retries_taken)
         self._prepare_request(request)
 
+        if options.idempotency_key:
+            # ensure the idempotency key is reused between requests
+            input_options.idempotency_key = options.idempotency_key
+
         kwargs: HttpxSendArgs = {}
         if self.custom_auth is not None:
             kwargs["auth"] = self.custom_auth
@@ -1315,6 +1362,7 @@ def __init__(
         *,
         version: str,
         base_url: str | URL,
+        api_version: str,
         _strict_response_validation: bool,
         max_retries: int = DEFAULT_MAX_RETRIES,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
@@ -1343,6 +1391,7 @@ def __init__(
         super().__init__(
             version=version,
             base_url=base_url,
+            api_version=api_version,
             # cast to a valid type because mypy doesn't understand our type narrowing
             timeout=cast(Timeout, timeout),
             max_retries=max_retries,
@@ -1475,6 +1524,10 @@ async def _request(
         request = self._build_request(options, retries_taken=retries_taken)
         await self._prepare_request(request)
 
+        if options.idempotency_key:
+            # ensure the idempotency key is reused between requests
+            input_options.idempotency_key = options.idempotency_key
+
         kwargs: HttpxSendArgs = {}
         if self.custom_auth is not None:
             kwargs["auth"] = self.custom_auth
@@ -1794,6 +1847,7 @@ def make_request_options(
     idempotency_key: str | None = None,
     timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     post_parser: PostParser | NotGiven = NOT_GIVEN,
+    multipart_syntax: MultipartSyntax | None = None,
 ) -> RequestOptions:
     """Create a dict of type RequestOptions without keys of NotGiven values."""
     options: RequestOptions = {}
@@ -1819,6 +1873,9 @@ def make_request_options(
         # internal
         options["post_parser"] = post_parser  # type: ignore
 
+    if multipart_syntax is not None:
+        options["multipart_syntax"] = multipart_syntax
+
     return options