Skip to content

Commit ee85bf1

Browse files
stainless-app[bot]stainless-bot
stainless-app[bot]
authored and
stainless-bot
committed
feat(api): OpenAPI spec update via Stainless API (#788)
1 parent ecf6363 commit ee85bf1

File tree

16 files changed

+136
-83
lines changed

16 files changed

+136
-83
lines changed

‎.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 1335
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-e83b5eb5706ca8b525141f506338cd1d465eb133815b9ddc53df612ea4a2ecef.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-0be7a22d1cc24a2a63cf7c7d9324fa078990d35e80629e2cbd28b9838940d75d.yml

‎api.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -3165,6 +3165,7 @@ from cloudflare.types.rulesets import (
31653165
Ruleset,
31663166
RulesetCreateResponse,
31673167
RulesetUpdateResponse,
3168+
RulesetListResponse,
31683169
RulesetGetResponse,
31693170
)
31703171
```
@@ -3173,7 +3174,7 @@ Methods:
31733174

31743175
- <code title="post /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/cloudflare/resources/rulesets/rulesets.py">create</a>(\*, account_id, zone_id, \*\*<a href="src/cloudflare/types/rulesets/ruleset_create_params.py">params</a>) -> <a href="./src/cloudflare/types/rulesets/ruleset_create_response.py">RulesetCreateResponse</a></code>
31753176
- <code title="put /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/cloudflare/resources/rulesets/rulesets.py">update</a>(ruleset_id, \*, account_id, zone_id, \*\*<a href="src/cloudflare/types/rulesets/ruleset_update_params.py">params</a>) -> <a href="./src/cloudflare/types/rulesets/ruleset_update_response.py">RulesetUpdateResponse</a></code>
3176-
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/cloudflare/resources/rulesets/rulesets.py">list</a>(\*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/ruleset.py">SyncSinglePage[Ruleset]</a></code>
3177+
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets">client.rulesets.<a href="./src/cloudflare/resources/rulesets/rulesets.py">list</a>(\*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/ruleset_list_response.py">SyncSinglePage[RulesetListResponse]</a></code>
31773178
- <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/cloudflare/resources/rulesets/rulesets.py">delete</a>(ruleset_id, \*, account_id, zone_id) -> None</code>
31783179
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}">client.rulesets.<a href="./src/cloudflare/resources/rulesets/rulesets.py">get</a>(ruleset_id, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/ruleset_get_response.py">RulesetGetResponse</a></code>
31793180

@@ -3195,12 +3196,12 @@ Methods:
31953196
Types:
31963197

31973198
```python
3198-
from cloudflare.types.rulesets.phases import VersionGetResponse
3199+
from cloudflare.types.rulesets.phases import VersionListResponse, VersionGetResponse
31993200
```
32003201

32013202
Methods:
32023203

3203-
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions">client.rulesets.phases.versions.<a href="./src/cloudflare/resources/rulesets/phases/versions.py">list</a>(ruleset_phase, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/ruleset.py">SyncSinglePage[Ruleset]</a></code>
3204+
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions">client.rulesets.phases.versions.<a href="./src/cloudflare/resources/rulesets/phases/versions.py">list</a>(ruleset_phase, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/phases/version_list_response.py">SyncSinglePage[VersionListResponse]</a></code>
32043205
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}">client.rulesets.phases.versions.<a href="./src/cloudflare/resources/rulesets/phases/versions.py">get</a>(ruleset_version, \*, ruleset_phase, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/phases/version_get_response.py">VersionGetResponse</a></code>
32053206

32063207
## Rules
@@ -3244,12 +3245,12 @@ Methods:
32443245
Types:
32453246

32463247
```python
3247-
from cloudflare.types.rulesets import VersionGetResponse
3248+
from cloudflare.types.rulesets import VersionListResponse, VersionGetResponse
32483249
```
32493250

32503251
Methods:
32513252

3252-
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions">client.rulesets.versions.<a href="./src/cloudflare/resources/rulesets/versions/versions.py">list</a>(ruleset_id, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/ruleset.py">SyncSinglePage[Ruleset]</a></code>
3253+
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions">client.rulesets.versions.<a href="./src/cloudflare/resources/rulesets/versions/versions.py">list</a>(ruleset_id, \*, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/version_list_response.py">SyncSinglePage[VersionListResponse]</a></code>
32533254
- <code title="delete /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}">client.rulesets.versions.<a href="./src/cloudflare/resources/rulesets/versions/versions.py">delete</a>(ruleset_version, \*, ruleset_id, account_id, zone_id) -> None</code>
32543255
- <code title="get /{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}">client.rulesets.versions.<a href="./src/cloudflare/resources/rulesets/versions/versions.py">get</a>(ruleset_version, \*, ruleset_id, account_id, zone_id) -> <a href="./src/cloudflare/types/rulesets/version_get_response.py">VersionGetResponse</a></code>
32553256

‎src/cloudflare/resources/rulesets/phases/phases.py

+1-10
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@
3131
from ...._base_client import (
3232
make_request_options,
3333
)
34-
from ....types.rulesets import Kind, Phase, phase_update_params
35-
from ....types.rulesets.kind import Kind
34+
from ....types.rulesets import Phase, phase_update_params
3635
from ....types.rulesets.phase import Phase
3736
from ....types.rulesets.phase_get_response import PhaseGetResponse
3837
from ....types.rulesets.phase_update_response import PhaseUpdateResponse
@@ -61,7 +60,6 @@ def update(
6160
account_id: str | NotGiven = NOT_GIVEN,
6261
zone_id: str | NotGiven = NOT_GIVEN,
6362
description: str | NotGiven = NOT_GIVEN,
64-
kind: Kind | NotGiven = NOT_GIVEN,
6563
name: str | NotGiven = NOT_GIVEN,
6664
phase: Phase | NotGiven = NOT_GIVEN,
6765
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -85,8 +83,6 @@ def update(
8583
8684
description: An informative description of the ruleset.
8785
88-
kind: The kind of the ruleset.
89-
9086
name: The human-readable name of the ruleset.
9187
9288
phase: The phase of the ruleset.
@@ -119,7 +115,6 @@ def update(
119115
{
120116
"rules": rules,
121117
"description": description,
122-
"kind": kind,
123118
"name": name,
124119
"phase": phase,
125120
},
@@ -215,7 +210,6 @@ async def update(
215210
account_id: str | NotGiven = NOT_GIVEN,
216211
zone_id: str | NotGiven = NOT_GIVEN,
217212
description: str | NotGiven = NOT_GIVEN,
218-
kind: Kind | NotGiven = NOT_GIVEN,
219213
name: str | NotGiven = NOT_GIVEN,
220214
phase: Phase | NotGiven = NOT_GIVEN,
221215
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -239,8 +233,6 @@ async def update(
239233
240234
description: An informative description of the ruleset.
241235
242-
kind: The kind of the ruleset.
243-
244236
name: The human-readable name of the ruleset.
245237
246238
phase: The phase of the ruleset.
@@ -273,7 +265,6 @@ async def update(
273265
{
274266
"rules": rules,
275267
"description": description,
276-
"kind": kind,
277268
"name": name,
278269
"phase": phase,
279270
},

‎src/cloudflare/resources/rulesets/phases/versions.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
)
2424
from ....types.rulesets import Phase
2525
from ....types.rulesets.phase import Phase
26-
from ....types.rulesets.ruleset import Ruleset
2726
from ....types.rulesets.phases.version_get_response import VersionGetResponse
27+
from ....types.rulesets.phases.version_list_response import VersionListResponse
2828

2929
__all__ = ["VersionsResource", "AsyncVersionsResource"]
3030

@@ -50,7 +50,7 @@ def list(
5050
extra_query: Query | None = None,
5151
extra_body: Body | None = None,
5252
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
53-
) -> SyncSinglePage[Ruleset]:
53+
) -> SyncSinglePage[VersionListResponse]:
5454
"""
5555
Fetches the versions of an account or zone entry point ruleset.
5656
@@ -85,11 +85,11 @@ def list(
8585
account_or_zone_id = zone_id
8686
return self._get_api_list(
8787
f"/{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions",
88-
page=SyncSinglePage[Ruleset],
88+
page=SyncSinglePage[VersionListResponse],
8989
options=make_request_options(
9090
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
9191
),
92-
model=Ruleset,
92+
model=VersionListResponse,
9393
)
9494

9595
def get(
@@ -176,7 +176,7 @@ def list(
176176
extra_query: Query | None = None,
177177
extra_body: Body | None = None,
178178
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
179-
) -> AsyncPaginator[Ruleset, AsyncSinglePage[Ruleset]]:
179+
) -> AsyncPaginator[VersionListResponse, AsyncSinglePage[VersionListResponse]]:
180180
"""
181181
Fetches the versions of an account or zone entry point ruleset.
182182
@@ -211,11 +211,11 @@ def list(
211211
account_or_zone_id = zone_id
212212
return self._get_api_list(
213213
f"/{account_or_zone}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions",
214-
page=AsyncSinglePage[Ruleset],
214+
page=AsyncSinglePage[VersionListResponse],
215215
options=make_request_options(
216216
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
217217
),
218-
model=Ruleset,
218+
model=VersionListResponse,
219219
)
220220

221221
async def get(

‎src/cloudflare/resources/rulesets/rulesets.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@
5454
from .versions.versions import VersionsResource, AsyncVersionsResource
5555
from ...types.rulesets.kind import Kind
5656
from ...types.rulesets.phase import Phase
57-
from ...types.rulesets.ruleset import Ruleset
5857
from ...types.rulesets.ruleset_get_response import RulesetGetResponse
58+
from ...types.rulesets.ruleset_list_response import RulesetListResponse
5959
from ...types.rulesets.ruleset_create_response import RulesetCreateResponse
6060
from ...types.rulesets.ruleset_update_response import RulesetUpdateResponse
6161

@@ -253,7 +253,7 @@ def list(
253253
extra_query: Query | None = None,
254254
extra_body: Body | None = None,
255255
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
256-
) -> SyncSinglePage[Ruleset]:
256+
) -> SyncSinglePage[RulesetListResponse]:
257257
"""
258258
Fetches all rulesets.
259259
@@ -284,11 +284,11 @@ def list(
284284
account_or_zone_id = zone_id
285285
return self._get_api_list(
286286
f"/{account_or_zone}/{account_or_zone_id}/rulesets",
287-
page=SyncSinglePage[Ruleset],
287+
page=SyncSinglePage[RulesetListResponse],
288288
options=make_request_options(
289289
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
290290
),
291-
model=Ruleset,
291+
model=RulesetListResponse,
292292
)
293293

294294
def delete(
@@ -594,7 +594,7 @@ def list(
594594
extra_query: Query | None = None,
595595
extra_body: Body | None = None,
596596
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
597-
) -> AsyncPaginator[Ruleset, AsyncSinglePage[Ruleset]]:
597+
) -> AsyncPaginator[RulesetListResponse, AsyncSinglePage[RulesetListResponse]]:
598598
"""
599599
Fetches all rulesets.
600600
@@ -625,11 +625,11 @@ def list(
625625
account_or_zone_id = zone_id
626626
return self._get_api_list(
627627
f"/{account_or_zone}/{account_or_zone_id}/rulesets",
628-
page=AsyncSinglePage[Ruleset],
628+
page=AsyncSinglePage[RulesetListResponse],
629629
options=make_request_options(
630630
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
631631
),
632-
model=Ruleset,
632+
model=RulesetListResponse,
633633
)
634634

635635
async def delete(

‎src/cloudflare/resources/rulesets/versions/versions.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
AsyncPaginator,
3030
make_request_options,
3131
)
32-
from ....types.rulesets.ruleset import Ruleset
3332
from ....types.rulesets.version_get_response import VersionGetResponse
33+
from ....types.rulesets.version_list_response import VersionListResponse
3434

3535
__all__ = ["VersionsResource", "AsyncVersionsResource"]
3636

@@ -60,7 +60,7 @@ def list(
6060
extra_query: Query | None = None,
6161
extra_body: Body | None = None,
6262
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
63-
) -> SyncSinglePage[Ruleset]:
63+
) -> SyncSinglePage[VersionListResponse]:
6464
"""
6565
Fetches the versions of an account or zone ruleset.
6666
@@ -95,11 +95,11 @@ def list(
9595
account_or_zone_id = zone_id
9696
return self._get_api_list(
9797
f"/{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions",
98-
page=SyncSinglePage[Ruleset],
98+
page=SyncSinglePage[VersionListResponse],
9999
options=make_request_options(
100100
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
101101
),
102-
model=Ruleset,
102+
model=VersionListResponse,
103103
)
104104

105105
def delete(
@@ -249,7 +249,7 @@ def list(
249249
extra_query: Query | None = None,
250250
extra_body: Body | None = None,
251251
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
252-
) -> AsyncPaginator[Ruleset, AsyncSinglePage[Ruleset]]:
252+
) -> AsyncPaginator[VersionListResponse, AsyncSinglePage[VersionListResponse]]:
253253
"""
254254
Fetches the versions of an account or zone ruleset.
255255
@@ -284,11 +284,11 @@ def list(
284284
account_or_zone_id = zone_id
285285
return self._get_api_list(
286286
f"/{account_or_zone}/{account_or_zone_id}/rulesets/{ruleset_id}/versions",
287-
page=AsyncSinglePage[Ruleset],
287+
page=AsyncSinglePage[VersionListResponse],
288288
options=make_request_options(
289289
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
290290
),
291-
model=Ruleset,
291+
model=VersionListResponse,
292292
)
293293

294294
async def delete(

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
from .kind import Kind as Kind
66
from .phase import Phase as Phase
77
from .logging import Logging as Logging
8-
from .ruleset import Ruleset as Ruleset
98
from .log_rule import LogRule as LogRule
109
from .skip_rule import SkipRule as SkipRule
1110
from .block_rule import BlockRule as BlockRule
@@ -40,8 +39,10 @@
4039
from .version_get_response import VersionGetResponse as VersionGetResponse
4140
from .phase_update_response import PhaseUpdateResponse as PhaseUpdateResponse
4241
from .ruleset_create_params import RulesetCreateParams as RulesetCreateParams
42+
from .ruleset_list_response import RulesetListResponse as RulesetListResponse
4343
from .ruleset_update_params import RulesetUpdateParams as RulesetUpdateParams
4444
from .set_config_rule_param import SetConfigRuleParam as SetConfigRuleParam
45+
from .version_list_response import VersionListResponse as VersionListResponse
4546
from .compress_response_rule import CompressResponseRule as CompressResponseRule
4647
from .managed_challenge_rule import ManagedChallengeRule as ManagedChallengeRule
4748
from .rewrite_uri_part_param import RewriteURIPartParam as RewriteURIPartParam

‎src/cloudflare/types/rulesets/phase_update_params.py

-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
from typing import Union, Iterable
66
from typing_extensions import Literal, Required, TypedDict
77

8-
from .kind import Kind
98
from .phase import Phase
109
from .logging_param import LoggingParam
1110
from .log_rule_param import LogRuleParam
@@ -50,9 +49,6 @@ class PhaseUpdateParams(TypedDict, total=False):
5049
description: str
5150
"""An informative description of the ruleset."""
5251

53-
kind: Kind
54-
"""The kind of the ruleset."""
55-
5652
name: str
5753
"""The human-readable name of the ruleset."""
5854

‎src/cloudflare/types/rulesets/phases/__init__.py

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
from __future__ import annotations
44

55
from .version_get_response import VersionGetResponse as VersionGetResponse
6+
from .version_list_response import VersionListResponse as VersionListResponse

‎src/cloudflare/types/rulesets/phases/version_list_response.py

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
from typing import Optional
4+
from datetime import datetime
5+
6+
from ..kind import Kind
7+
from ..phase import Phase
8+
from ...._models import BaseModel
9+
10+
__all__ = ["VersionListResponse"]
11+
12+
13+
class VersionListResponse(BaseModel):
14+
id: str
15+
"""The unique ID of the ruleset."""
16+
17+
kind: Kind
18+
"""The kind of the ruleset."""
19+
20+
last_updated: datetime
21+
"""The timestamp of when the ruleset was last modified."""
22+
23+
name: str
24+
"""The human-readable name of the ruleset."""
25+
26+
phase: Phase
27+
"""The phase of the ruleset."""
28+
29+
version: str
30+
"""The version of the ruleset."""
31+
32+
description: Optional[str] = None
33+
"""An informative description of the ruleset."""

‎src/cloudflare/types/rulesets/ruleset.py ‎src/cloudflare/types/rulesets/ruleset_list_response.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,27 @@
77
from .phase import Phase
88
from ..._models import BaseModel
99

10-
__all__ = ["Ruleset"]
10+
__all__ = ["RulesetListResponse"]
1111

1212

13-
class Ruleset(BaseModel):
13+
class RulesetListResponse(BaseModel):
1414
id: str
1515
"""The unique ID of the ruleset."""
1616

17+
kind: Kind
18+
"""The kind of the ruleset."""
19+
1720
last_updated: datetime
1821
"""The timestamp of when the ruleset was last modified."""
1922

23+
name: str
24+
"""The human-readable name of the ruleset."""
25+
26+
phase: Phase
27+
"""The phase of the ruleset."""
28+
2029
version: str
2130
"""The version of the ruleset."""
2231

2332
description: Optional[str] = None
2433
"""An informative description of the ruleset."""
25-
26-
kind: Optional[Kind] = None
27-
"""The kind of the ruleset."""
28-
29-
name: Optional[str] = None
30-
"""The human-readable name of the ruleset."""
31-
32-
phase: Optional[Phase] = None
33-
"""The phase of the ruleset."""

0 commit comments

Comments
 (0)