Skip to content

Commit db76849

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update (#2290)
1 parent 9cb1e41 commit db76849

15 files changed

+343
-161
lines changed

‎.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 1480
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-a2d9b92dd116fb25fdcd7969ee039a099a9cea04182925b450f5dd5e3b4dedfb.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-940940879e4920ccdb9e851d6a4f0f3c313303b4917c6e3c49e81b7e44f1506c.yml

‎api.md

-1
Original file line numberDiff line numberDiff line change
@@ -2820,7 +2820,6 @@ Types:
28202820

28212821
```python
28222822
from cloudflare.types.managed_transforms import (
2823-
RequestModel,
28242823
ManagedTransformListResponse,
28252824
ManagedTransformEditResponse,
28262825
)

‎src/cloudflare/resources/managed_transforms.py

+42-18
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
from __future__ import annotations
44

5-
from typing import Iterable
5+
from typing import Type, Iterable, cast
66

77
import httpx
88

@@ -19,9 +19,9 @@
1919
async_to_raw_response_wrapper,
2020
async_to_streamed_response_wrapper,
2121
)
22+
from .._wrappers import ResultWrapper
2223
from .._base_client import make_request_options
2324
from ..types.managed_transforms import managed_transform_edit_params
24-
from ..types.managed_transforms.request_model_param import RequestModelParam
2525
from ..types.managed_transforms.managed_transform_edit_response import ManagedTransformEditResponse
2626
from ..types.managed_transforms.managed_transform_list_response import ManagedTransformListResponse
2727

@@ -63,7 +63,7 @@ def list(
6363
Fetches a list of all Managed Transforms.
6464
6565
Args:
66-
zone_id: Identifier
66+
zone_id: The unique ID of the zone.
6767
6868
extra_headers: Send extra headers
6969
@@ -78,17 +78,21 @@ def list(
7878
return self._get(
7979
f"/zones/{zone_id}/managed_headers",
8080
options=make_request_options(
81-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
81+
extra_headers=extra_headers,
82+
extra_query=extra_query,
83+
extra_body=extra_body,
84+
timeout=timeout,
85+
post_parser=ResultWrapper[ManagedTransformListResponse]._unwrapper,
8286
),
83-
cast_to=ManagedTransformListResponse,
87+
cast_to=cast(Type[ManagedTransformListResponse], ResultWrapper[ManagedTransformListResponse]),
8488
)
8589

8690
def edit(
8791
self,
8892
*,
8993
zone_id: str,
90-
managed_request_headers: Iterable[RequestModelParam],
91-
managed_response_headers: Iterable[RequestModelParam],
94+
managed_request_headers: Iterable[managed_transform_edit_params.ManagedRequestHeader],
95+
managed_response_headers: Iterable[managed_transform_edit_params.ManagedResponseHeader],
9296
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
9397
# The extra values given here take precedence over values defined on the client or passed to this method.
9498
extra_headers: Headers | None = None,
@@ -100,7 +104,11 @@ def edit(
100104
Updates the status of one or more Managed Transforms.
101105
102106
Args:
103-
zone_id: Identifier
107+
zone_id: The unique ID of the zone.
108+
109+
managed_request_headers: The list of Managed Request Transforms.
110+
111+
managed_response_headers: The list of Managed Response Transforms.
104112
105113
extra_headers: Send extra headers
106114
@@ -122,9 +130,13 @@ def edit(
122130
managed_transform_edit_params.ManagedTransformEditParams,
123131
),
124132
options=make_request_options(
125-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
133+
extra_headers=extra_headers,
134+
extra_query=extra_query,
135+
extra_body=extra_body,
136+
timeout=timeout,
137+
post_parser=ResultWrapper[ManagedTransformEditResponse]._unwrapper,
126138
),
127-
cast_to=ManagedTransformEditResponse,
139+
cast_to=cast(Type[ManagedTransformEditResponse], ResultWrapper[ManagedTransformEditResponse]),
128140
)
129141

130142

@@ -163,7 +175,7 @@ async def list(
163175
Fetches a list of all Managed Transforms.
164176
165177
Args:
166-
zone_id: Identifier
178+
zone_id: The unique ID of the zone.
167179
168180
extra_headers: Send extra headers
169181
@@ -178,17 +190,21 @@ async def list(
178190
return await self._get(
179191
f"/zones/{zone_id}/managed_headers",
180192
options=make_request_options(
181-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
193+
extra_headers=extra_headers,
194+
extra_query=extra_query,
195+
extra_body=extra_body,
196+
timeout=timeout,
197+
post_parser=ResultWrapper[ManagedTransformListResponse]._unwrapper,
182198
),
183-
cast_to=ManagedTransformListResponse,
199+
cast_to=cast(Type[ManagedTransformListResponse], ResultWrapper[ManagedTransformListResponse]),
184200
)
185201

186202
async def edit(
187203
self,
188204
*,
189205
zone_id: str,
190-
managed_request_headers: Iterable[RequestModelParam],
191-
managed_response_headers: Iterable[RequestModelParam],
206+
managed_request_headers: Iterable[managed_transform_edit_params.ManagedRequestHeader],
207+
managed_response_headers: Iterable[managed_transform_edit_params.ManagedResponseHeader],
192208
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
193209
# The extra values given here take precedence over values defined on the client or passed to this method.
194210
extra_headers: Headers | None = None,
@@ -200,7 +216,11 @@ async def edit(
200216
Updates the status of one or more Managed Transforms.
201217
202218
Args:
203-
zone_id: Identifier
219+
zone_id: The unique ID of the zone.
220+
221+
managed_request_headers: The list of Managed Request Transforms.
222+
223+
managed_response_headers: The list of Managed Response Transforms.
204224
205225
extra_headers: Send extra headers
206226
@@ -222,9 +242,13 @@ async def edit(
222242
managed_transform_edit_params.ManagedTransformEditParams,
223243
),
224244
options=make_request_options(
225-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
245+
extra_headers=extra_headers,
246+
extra_query=extra_query,
247+
extra_body=extra_body,
248+
timeout=timeout,
249+
post_parser=ResultWrapper[ManagedTransformEditResponse]._unwrapper,
226250
),
227-
cast_to=ManagedTransformEditResponse,
251+
cast_to=cast(Type[ManagedTransformEditResponse], ResultWrapper[ManagedTransformEditResponse]),
228252
)
229253

230254

‎src/cloudflare/resources/url_normalization.py

+40-20
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
from __future__ import annotations
44

5+
from typing import Type, cast
6+
from typing_extensions import Literal
7+
58
import httpx
69

710
from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
@@ -17,6 +20,7 @@
1720
async_to_raw_response_wrapper,
1821
async_to_streamed_response_wrapper,
1922
)
23+
from .._wrappers import ResultWrapper
2024
from .._base_client import make_request_options
2125
from ..types.url_normalization import url_normalization_update_params
2226
from ..types.url_normalization.url_normalization_get_response import URLNormalizationGetResponse
@@ -49,8 +53,8 @@ def update(
4953
self,
5054
*,
5155
zone_id: str,
52-
scope: str | NotGiven = NOT_GIVEN,
53-
type: str | NotGiven = NOT_GIVEN,
56+
scope: Literal["incoming", "both"],
57+
type: Literal["cloudflare", "rfc3986"],
5458
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
5559
# The extra values given here take precedence over values defined on the client or passed to this method.
5660
extra_headers: Headers | None = None,
@@ -59,10 +63,10 @@ def update(
5963
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
6064
) -> URLNormalizationUpdateResponse:
6165
"""
62-
Updates the URL normalization settings.
66+
Updates the URL Normalization settings.
6367
6468
Args:
65-
zone_id: Identifier
69+
zone_id: The unique ID of the zone.
6670
6771
scope: The scope of the URL normalization.
6872
@@ -88,9 +92,13 @@ def update(
8892
url_normalization_update_params.URLNormalizationUpdateParams,
8993
),
9094
options=make_request_options(
91-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
95+
extra_headers=extra_headers,
96+
extra_query=extra_query,
97+
extra_body=extra_body,
98+
timeout=timeout,
99+
post_parser=ResultWrapper[URLNormalizationUpdateResponse]._unwrapper,
92100
),
93-
cast_to=URLNormalizationUpdateResponse,
101+
cast_to=cast(Type[URLNormalizationUpdateResponse], ResultWrapper[URLNormalizationUpdateResponse]),
94102
)
95103

96104
def get(
@@ -105,10 +113,10 @@ def get(
105113
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
106114
) -> URLNormalizationGetResponse:
107115
"""
108-
Fetches the current URL normalization settings.
116+
Fetches the current URL Normalization settings.
109117
110118
Args:
111-
zone_id: Identifier
119+
zone_id: The unique ID of the zone.
112120
113121
extra_headers: Send extra headers
114122
@@ -123,9 +131,13 @@ def get(
123131
return self._get(
124132
f"/zones/{zone_id}/url_normalization",
125133
options=make_request_options(
126-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
134+
extra_headers=extra_headers,
135+
extra_query=extra_query,
136+
extra_body=extra_body,
137+
timeout=timeout,
138+
post_parser=ResultWrapper[URLNormalizationGetResponse]._unwrapper,
127139
),
128-
cast_to=URLNormalizationGetResponse,
140+
cast_to=cast(Type[URLNormalizationGetResponse], ResultWrapper[URLNormalizationGetResponse]),
129141
)
130142

131143

@@ -153,8 +165,8 @@ async def update(
153165
self,
154166
*,
155167
zone_id: str,
156-
scope: str | NotGiven = NOT_GIVEN,
157-
type: str | NotGiven = NOT_GIVEN,
168+
scope: Literal["incoming", "both"],
169+
type: Literal["cloudflare", "rfc3986"],
158170
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
159171
# The extra values given here take precedence over values defined on the client or passed to this method.
160172
extra_headers: Headers | None = None,
@@ -163,10 +175,10 @@ async def update(
163175
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
164176
) -> URLNormalizationUpdateResponse:
165177
"""
166-
Updates the URL normalization settings.
178+
Updates the URL Normalization settings.
167179
168180
Args:
169-
zone_id: Identifier
181+
zone_id: The unique ID of the zone.
170182
171183
scope: The scope of the URL normalization.
172184
@@ -192,9 +204,13 @@ async def update(
192204
url_normalization_update_params.URLNormalizationUpdateParams,
193205
),
194206
options=make_request_options(
195-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
207+
extra_headers=extra_headers,
208+
extra_query=extra_query,
209+
extra_body=extra_body,
210+
timeout=timeout,
211+
post_parser=ResultWrapper[URLNormalizationUpdateResponse]._unwrapper,
196212
),
197-
cast_to=URLNormalizationUpdateResponse,
213+
cast_to=cast(Type[URLNormalizationUpdateResponse], ResultWrapper[URLNormalizationUpdateResponse]),
198214
)
199215

200216
async def get(
@@ -209,10 +225,10 @@ async def get(
209225
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
210226
) -> URLNormalizationGetResponse:
211227
"""
212-
Fetches the current URL normalization settings.
228+
Fetches the current URL Normalization settings.
213229
214230
Args:
215-
zone_id: Identifier
231+
zone_id: The unique ID of the zone.
216232
217233
extra_headers: Send extra headers
218234
@@ -227,9 +243,13 @@ async def get(
227243
return await self._get(
228244
f"/zones/{zone_id}/url_normalization",
229245
options=make_request_options(
230-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
246+
extra_headers=extra_headers,
247+
extra_query=extra_query,
248+
extra_body=extra_body,
249+
timeout=timeout,
250+
post_parser=ResultWrapper[URLNormalizationGetResponse]._unwrapper,
231251
),
232-
cast_to=URLNormalizationGetResponse,
252+
cast_to=cast(Type[URLNormalizationGetResponse], ResultWrapper[URLNormalizationGetResponse]),
233253
)
234254

235255

‎src/cloudflare/types/managed_transforms/__init__.py

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
from __future__ import annotations
44

5-
from .request_model import RequestModel as RequestModel
6-
from .request_model_param import RequestModelParam as RequestModelParam
75
from .managed_transform_edit_params import ManagedTransformEditParams as ManagedTransformEditParams
86
from .managed_transform_edit_response import ManagedTransformEditResponse as ManagedTransformEditResponse
97
from .managed_transform_list_response import ManagedTransformListResponse as ManagedTransformListResponse

‎src/cloudflare/types/managed_transforms/managed_transform_edit_params.py

+22-6
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,31 @@
55
from typing import Iterable
66
from typing_extensions import Required, TypedDict
77

8-
from .request_model_param import RequestModelParam
9-
10-
__all__ = ["ManagedTransformEditParams"]
8+
__all__ = ["ManagedTransformEditParams", "ManagedRequestHeader", "ManagedResponseHeader"]
119

1210

1311
class ManagedTransformEditParams(TypedDict, total=False):
1412
zone_id: Required[str]
15-
"""Identifier"""
13+
"""The unique ID of the zone."""
14+
15+
managed_request_headers: Required[Iterable[ManagedRequestHeader]]
16+
"""The list of Managed Request Transforms."""
17+
18+
managed_response_headers: Required[Iterable[ManagedResponseHeader]]
19+
"""The list of Managed Response Transforms."""
20+
21+
22+
class ManagedRequestHeader(TypedDict, total=False):
23+
id: Required[str]
24+
"""The human-readable identifier of the Managed Transform."""
25+
26+
enabled: Required[bool]
27+
"""Whether the Managed Transform is enabled."""
28+
1629

17-
managed_request_headers: Required[Iterable[RequestModelParam]]
30+
class ManagedResponseHeader(TypedDict, total=False):
31+
id: Required[str]
32+
"""The human-readable identifier of the Managed Transform."""
1833

19-
managed_response_headers: Required[Iterable[RequestModelParam]]
34+
enabled: Required[bool]
35+
"""Whether the Managed Transform is enabled."""

0 commit comments

Comments
 (0)