Skip to content

Commit a98fa44

Browse files
musa-cfmusa-cf
committed
feat(zones): update generated types and methods
1 parent 8171907 commit a98fa44

22 files changed

Lines changed: 431 additions & 136 deletions

‎src/cloudflare/resources/zones/activation_check.py‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import httpx
88

99
from ..._types import Body, Query, Headers, NotGiven, not_given
10+
from ..._utils import path_template
1011
from ..._compat import cached_property
1112
from ..._resource import SyncAPIResource, AsyncAPIResource
1213
from ..._response import (
@@ -45,7 +46,7 @@ def with_streaming_response(self) -> ActivationCheckResourceWithStreamingRespons
4546
def trigger(
4647
self,
4748
*,
48-
zone_id: str,
49+
zone_id: str | None = None,
4950
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
5051
# The extra values given here take precedence over values defined on the client or passed to this method.
5152
extra_headers: Headers | None = None,
@@ -69,10 +70,12 @@ def trigger(
6970
7071
timeout: Override the client-level default timeout for this request, in seconds
7172
"""
73+
if zone_id is None:
74+
zone_id = self._client._get_zone_id_path_param()
7275
if not zone_id:
7376
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
7477
return self._put(
75-
f"/zones/{zone_id}/activation_check",
78+
path_template("/zones/{zone_id}/activation_check", zone_id=zone_id),
7679
options=make_request_options(
7780
extra_headers=extra_headers,
7881
extra_query=extra_query,
@@ -107,7 +110,7 @@ def with_streaming_response(self) -> AsyncActivationCheckResourceWithStreamingRe
107110
async def trigger(
108111
self,
109112
*,
110-
zone_id: str,
113+
zone_id: str | None = None,
111114
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
112115
# The extra values given here take precedence over values defined on the client or passed to this method.
113116
extra_headers: Headers | None = None,
@@ -131,10 +134,12 @@ async def trigger(
131134
132135
timeout: Override the client-level default timeout for this request, in seconds
133136
"""
137+
if zone_id is None:
138+
zone_id = self._client._get_zone_id_path_param()
134139
if not zone_id:
135140
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
136141
return await self._put(
137-
f"/zones/{zone_id}/activation_check",
142+
path_template("/zones/{zone_id}/activation_check", zone_id=zone_id),
138143
options=make_request_options(
139144
extra_headers=extra_headers,
140145
extra_query=extra_query,

‎src/cloudflare/resources/zones/api.md‎

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
# Zones
2+
3+
Types:
4+
5+
```python
6+
from cloudflare.types.zones import Type, Zone, ZoneDeleteResponse
7+
```
8+
9+
Methods:
10+
11+
- <code title="post /zones">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">create</a>(\*\*<a href="src/cloudflare/types/zones/zone_create_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/zone.py">Optional[Zone]</a></code>
12+
- <code title="get /zones">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">list</a>(\*\*<a href="src/cloudflare/types/zones/zone_list_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/zone.py">SyncV4PagePaginationArray[Zone]</a></code>
13+
- <code title="delete /zones/{zone_id}">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">delete</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/zone_delete_response.py">Optional[ZoneDeleteResponse]</a></code>
14+
- <code title="patch /zones/{zone_id}">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/zone_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/zone.py">Optional[Zone]</a></code>
15+
- <code title="get /zones/{zone_id}">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/zone.py">Optional[Zone]</a></code>
16+
17+
## ActivationCheck
18+
19+
Types:
20+
21+
```python
22+
from cloudflare.types.zones import ActivationCheckTriggerResponse
23+
```
24+
25+
Methods:
26+
27+
- <code title="put /zones/{zone_id}/activation_check">client.zones.activation_check.<a href="./src/cloudflare/resources/zones/activation_check.py">trigger</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/activation_check_trigger_response.py">Optional[ActivationCheckTriggerResponse]</a></code>
28+
29+
## Settings
30+
31+
Types:
32+
33+
```python
34+
from cloudflare.types.zones import (
35+
AdvancedDDoS,
36+
Aegis,
37+
AlwaysOnline,
38+
AlwaysUseHTTPS,
39+
AutomaticHTTPSRewrites,
40+
AutomaticPlatformOptimization,
41+
Brotli,
42+
BrowserCacheTTL,
43+
BrowserCheck,
44+
CacheLevel,
45+
ChallengeTTL,
46+
Ciphers,
47+
DevelopmentMode,
48+
EarlyHints,
49+
EmailObfuscation,
50+
FontSettings,
51+
H2Prioritization,
52+
HotlinkProtection,
53+
HTTP2,
54+
HTTP3,
55+
ImageResizing,
56+
IPGeolocation,
57+
IPV6,
58+
MinTLSVersion,
59+
Mirage,
60+
NEL,
61+
OpportunisticEncryption,
62+
OpportunisticOnion,
63+
OrangeToOrange,
64+
OriginErrorPagePassThru,
65+
OriginMaxHTTPVersion,
66+
Polish,
67+
PrefetchPreload,
68+
ProxyReadTimeout,
69+
PseudoIPV4,
70+
ResponseBuffering,
71+
RocketLoader,
72+
SecurityHeaders,
73+
SecurityLevel,
74+
ServerSideExcludes,
75+
SortQueryStringForCache,
76+
SSL,
77+
SSLRecommender,
78+
TLS1_3,
79+
TLSClientAuth,
80+
TrueClientIPHeader,
81+
WAF,
82+
WebP,
83+
Websocket,
84+
ZeroRTT,
85+
SettingEditResponse,
86+
SettingGetResponse,
87+
)
88+
```
89+
90+
Methods:
91+
92+
- <code title="patch /zones/{zone_id}/settings/{setting_id}">client.zones.settings.<a href="./src/cloudflare/resources/zones/settings.py">edit</a>(setting_id, \*, zone_id, \*\*<a href="src/cloudflare/types/zones/setting_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/setting_edit_response.py">Optional[SettingEditResponse]</a></code>
93+
- <code title="get /zones/{zone_id}/settings/{setting_id}">client.zones.settings.<a href="./src/cloudflare/resources/zones/settings.py">get</a>(setting_id, \*, zone_id) -> <a href="./src/cloudflare/types/zones/setting_get_response.py">Optional[SettingGetResponse]</a></code>
94+
95+
## Environments
96+
97+
Types:
98+
99+
```python
100+
from cloudflare.types.zones import (
101+
EnvironmentCreateResponse,
102+
EnvironmentUpdateResponse,
103+
EnvironmentListResponse,
104+
EnvironmentDeleteResponse,
105+
EnvironmentEditResponse,
106+
EnvironmentRollbackResponse,
107+
)
108+
```
109+
110+
Methods:
111+
112+
- <code title="post /zones/{zone_id}/environments">client.zones.environments.<a href="./src/cloudflare/resources/zones/environments.py">create</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/environment_create_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/environment_create_response.py">EnvironmentCreateResponse</a></code>
113+
- <code title="put /zones/{zone_id}/environments">client.zones.environments.<a href="./src/cloudflare/resources/zones/environments.py">update</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/environment_update_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/environment_update_response.py">EnvironmentUpdateResponse</a></code>
114+
- <code title="get /zones/{zone_id}/environments">client.zones.environments.<a href="./src/cloudflare/resources/zones/environments.py">list</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/environment_list_response.py">EnvironmentListResponse</a></code>
115+
- <code title="delete /zones/{zone_id}/environments/{environment_id}">client.zones.environments.<a href="./src/cloudflare/resources/zones/environments.py">delete</a>(environment_id, \*, zone_id) -> <a href="./src/cloudflare/types/zones/environment_delete_response.py">EnvironmentDeleteResponse</a></code>
116+
- <code title="patch /zones/{zone_id}/environments">client.zones.environments.<a href="./src/cloudflare/resources/zones/environments.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/environment_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/environment_edit_response.py">EnvironmentEditResponse</a></code>
117+
- <code title="post /zones/{zone_id}/environments/{environment_id}/rollback">client.zones.environments.<a href="./src/cloudflare/resources/zones/environments.py">rollback</a>(environment_id, \*, zone_id) -> <a href="./src/cloudflare/types/zones/environment_rollback_response.py">EnvironmentRollbackResponse</a></code>
118+
119+
## CustomNameservers
120+
121+
Types:
122+
123+
```python
124+
from cloudflare.types.zones import CustomNameserverUpdateResponse, CustomNameserverGetResponse
125+
```
126+
127+
Methods:
128+
129+
- <code title="put /zones/{zone_id}/custom_ns">client.zones.custom_nameservers.<a href="./src/cloudflare/resources/zones/custom_nameservers.py">update</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/custom_nameserver_update_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/custom_nameserver_update_response.py">SyncSinglePage[CustomNameserverUpdateResponse]</a></code>
130+
- <code title="get /zones/{zone_id}/custom_ns">client.zones.custom_nameservers.<a href="./src/cloudflare/resources/zones/custom_nameservers.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/custom_nameserver_get_response.py">CustomNameserverGetResponse</a></code>
131+
132+
## Holds
133+
134+
Types:
135+
136+
```python
137+
from cloudflare.types.zones import ZoneHold
138+
```
139+
140+
Methods:
141+
142+
- <code title="post /zones/{zone_id}/hold">client.zones.holds.<a href="./src/cloudflare/resources/zones/holds.py">create</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/hold_create_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/zone_hold.py">ZoneHold</a></code>
143+
- <code title="delete /zones/{zone_id}/hold">client.zones.holds.<a href="./src/cloudflare/resources/zones/holds.py">delete</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/hold_delete_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/zone_hold.py">ZoneHold</a></code>
144+
- <code title="patch /zones/{zone_id}/hold">client.zones.holds.<a href="./src/cloudflare/resources/zones/holds.py">edit</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/hold_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/zone_hold.py">ZoneHold</a></code>
145+
- <code title="get /zones/{zone_id}/hold">client.zones.holds.<a href="./src/cloudflare/resources/zones/holds.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/zone_hold.py">ZoneHold</a></code>
146+
147+
## Subscriptions
148+
149+
Types:
150+
151+
```python
152+
from cloudflare.types.zones import (
153+
SubscriptionCreateResponse,
154+
SubscriptionUpdateResponse,
155+
SubscriptionGetResponse,
156+
)
157+
```
158+
159+
Methods:
160+
161+
- <code title="post /zones/{zone_id}/subscription">client.zones.subscriptions.<a href="./src/cloudflare/resources/zones/subscriptions.py">create</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/subscription_create_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/subscription_create_response.py">SubscriptionCreateResponse</a></code>
162+
- <code title="put /zones/{zone_id}/subscription">client.zones.subscriptions.<a href="./src/cloudflare/resources/zones/subscriptions.py">update</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/zones/subscription_update_params.py">params</a>) -> <a href="./src/cloudflare/types/zones/subscription_update_response.py">SubscriptionUpdateResponse</a></code>
163+
- <code title="get /zones/{zone_id}/subscription">client.zones.subscriptions.<a href="./src/cloudflare/resources/zones/subscriptions.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/subscription_get_response.py">SubscriptionGetResponse</a></code>
164+
165+
## Plans
166+
167+
Types:
168+
169+
```python
170+
from cloudflare.types.zones import AvailableRatePlan
171+
```
172+
173+
Methods:
174+
175+
- <code title="get /zones/{zone_id}/available_plans">client.zones.plans.<a href="./src/cloudflare/resources/zones/plans.py">list</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/available_rate_plan.py">SyncSinglePage[AvailableRatePlan]</a></code>
176+
- <code title="get /zones/{zone_id}/available_plans/{plan_identifier}">client.zones.plans.<a href="./src/cloudflare/resources/zones/plans.py">get</a>(plan_identifier, \*, zone_id) -> <a href="./src/cloudflare/types/zones/available_rate_plan.py">AvailableRatePlan</a></code>
177+
178+
## RatePlans
179+
180+
Types:
181+
182+
```python
183+
from cloudflare.types.zones import RatePlanGetResponse
184+
```
185+
186+
Methods:
187+
188+
- <code title="get /zones/{zone_id}/available_rate_plans">client.zones.rate_plans.<a href="./src/cloudflare/resources/zones/rate_plans.py">get</a>(\*, zone_id) -> <a href="./src/cloudflare/types/zones/rate_plan_get_response.py">SyncSinglePage[RatePlanGetResponse]</a></code>

‎src/cloudflare/resources/zones/custom_nameservers.py‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import httpx
88

99
from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
10-
from ..._utils import maybe_transform
10+
from ..._utils import path_template, maybe_transform
1111
from ..._compat import cached_property
1212
from ..._resource import SyncAPIResource, AsyncAPIResource
1313
from ..._response import (
@@ -51,7 +51,7 @@ def with_streaming_response(self) -> CustomNameserversResourceWithStreamingRespo
5151
def update(
5252
self,
5353
*,
54-
zone_id: str,
54+
zone_id: str | None = None,
5555
enabled: bool | Omit = omit,
5656
ns_set: float | Omit = omit,
5757
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -86,10 +86,12 @@ def update(
8686
8787
timeout: Override the client-level default timeout for this request, in seconds
8888
"""
89+
if zone_id is None:
90+
zone_id = self._client._get_zone_id_path_param()
8991
if not zone_id:
9092
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
9193
return self._get_api_list(
92-
f"/zones/{zone_id}/custom_ns",
94+
path_template("/zones/{zone_id}/custom_ns", zone_id=zone_id),
9395
page=SyncSinglePage[CustomNameserverUpdateResponse],
9496
body=maybe_transform(
9597
{
@@ -111,7 +113,7 @@ def update(
111113
def get(
112114
self,
113115
*,
114-
zone_id: str,
116+
zone_id: str | None = None,
115117
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
116118
# The extra values given here take precedence over values defined on the client or passed to this method.
117119
extra_headers: Headers | None = None,
@@ -136,10 +138,12 @@ def get(
136138
137139
timeout: Override the client-level default timeout for this request, in seconds
138140
"""
141+
if zone_id is None:
142+
zone_id = self._client._get_zone_id_path_param()
139143
if not zone_id:
140144
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
141145
return self._get(
142-
f"/zones/{zone_id}/custom_ns",
146+
path_template("/zones/{zone_id}/custom_ns", zone_id=zone_id),
143147
options=make_request_options(
144148
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
145149
),
@@ -173,7 +177,7 @@ def with_streaming_response(self) -> AsyncCustomNameserversResourceWithStreaming
173177
def update(
174178
self,
175179
*,
176-
zone_id: str,
180+
zone_id: str | None = None,
177181
enabled: bool | Omit = omit,
178182
ns_set: float | Omit = omit,
179183
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -208,10 +212,12 @@ def update(
208212
209213
timeout: Override the client-level default timeout for this request, in seconds
210214
"""
215+
if zone_id is None:
216+
zone_id = self._client._get_zone_id_path_param()
211217
if not zone_id:
212218
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
213219
return self._get_api_list(
214-
f"/zones/{zone_id}/custom_ns",
220+
path_template("/zones/{zone_id}/custom_ns", zone_id=zone_id),
215221
page=AsyncSinglePage[CustomNameserverUpdateResponse],
216222
body=maybe_transform(
217223
{
@@ -233,7 +239,7 @@ def update(
233239
async def get(
234240
self,
235241
*,
236-
zone_id: str,
242+
zone_id: str | None = None,
237243
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
238244
# The extra values given here take precedence over values defined on the client or passed to this method.
239245
extra_headers: Headers | None = None,
@@ -258,10 +264,12 @@ async def get(
258264
259265
timeout: Override the client-level default timeout for this request, in seconds
260266
"""
267+
if zone_id is None:
268+
zone_id = self._client._get_zone_id_path_param()
261269
if not zone_id:
262270
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
263271
return await self._get(
264-
f"/zones/{zone_id}/custom_ns",
272+
path_template("/zones/{zone_id}/custom_ns", zone_id=zone_id),
265273
options=make_request_options(
266274
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
267275
),

0 commit comments

Comments
 (0)