Skip to content

Commit 4264982

Browse files
feat(api): OpenAPI spec update via Stainless API (#155)
1 parent f822fe5 commit 4264982

26 files changed

+175
-7154
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ client = Cloudflare(
3030
api_email=os.environ.get("CLOUDFLARE_EMAIL"),
3131
)
3232

33-
zone_create_response = client.zones.create(
33+
zone = client.zones.create(
3434
account={"id": "023e105f4ecef8ad9ca31a8372d0c353"},
3535
name="example.com",
3636
type="full",
3737
)
38-
print(zone_create_response.id)
38+
print(zone.id)
3939
```
4040

4141
While you can provide a `api_email` keyword argument,
@@ -59,12 +59,12 @@ client = AsyncCloudflare(
5959

6060

6161
async def main() -> None:
62-
zone_create_response = await client.zones.create(
62+
zone = await client.zones.create(
6363
account={"id": "023e105f4ecef8ad9ca31a8372d0c353"},
6464
name="example.com",
6565
type="full",
6666
)
67-
print(zone_create_response.id)
67+
print(zone.id)
6868

6969

7070
asyncio.run(main())

api.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -358,23 +358,16 @@ Methods:
358358
Types:
359359

360360
```python
361-
from cloudflare.types import (
362-
Zone,
363-
ZoneCreateResponse,
364-
ZoneListResponse,
365-
ZoneDeleteResponse,
366-
ZoneEditResponse,
367-
ZoneGetResponse,
368-
)
361+
from cloudflare.types import Zone, ZoneDeleteResponse
369362
```
370363

371364
Methods:
372365

373-
- <code title="post /zones">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">create</a>(\*\*<a href="src/cloudflare/types/zone_create_params.py">params</a>) -> <a href="./src/cloudflare/types/zone_create_response.py">Optional</a></code>
374-
- <code title="get /zones">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">list</a>(\*\*<a href="src/cloudflare/types/zone_list_params.py">params</a>) -> <a href="./src/cloudflare/types/zone_list_response.py">SyncV4PagePaginationArray[ZoneListResponse]</a></code>
366+
- <code title="post /zones">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">create</a>(\*\*<a href="src/cloudflare/types/zone_create_params.py">params</a>) -> <a href="./src/cloudflare/types/zone.py">Optional</a></code>
367+
- <code title="get /zones">client.zones.<a href="./src/cloudflare/resources/zones/zones.py">list</a>(\*\*<a href="src/cloudflare/types/zone_list_params.py">params</a>) -> <a href="./src/cloudflare/types/zone.py">SyncV4PagePaginationArray[Zone]</a></code>
375368
- <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/zone_delete_response.py">Optional</a></code>
376-
- <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/zone_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zone_edit_response.py">Optional</a></code>
377-
- <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/zone_get_response.py">Optional</a></code>
369+
- <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/zone_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/zone.py">Optional</a></code>
370+
- <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/zone.py">Optional</a></code>
378371

379372
## ActivationCheck
380373

@@ -1664,27 +1657,22 @@ Types:
16641657
```python
16651658
from cloudflare.types.dns import (
16661659
DNSRecord,
1667-
RecordCreateResponse,
1668-
RecordUpdateResponse,
1669-
RecordListResponse,
16701660
RecordDeleteResponse,
1671-
RecordEditResponse,
16721661
RecordExportResponse,
1673-
RecordGetResponse,
16741662
RecordImportResponse,
16751663
RecordScanResponse,
16761664
)
16771665
```
16781666

16791667
Methods:
16801668

1681-
- <code title="post /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">create</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_create_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/record_create_response.py">RecordCreateResponse</a></code>
1682-
- <code title="put /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">update</a>(dns_record_id, \*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_update_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/record_update_response.py">RecordUpdateResponse</a></code>
1683-
- <code title="get /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">list</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_list_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/record_list_response.py">SyncV4PagePaginationArray[RecordListResponse]</a></code>
1669+
- <code title="post /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">create</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_create_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/dns_record.py">DNSRecord</a></code>
1670+
- <code title="put /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">update</a>(dns_record_id, \*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_update_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/dns_record.py">DNSRecord</a></code>
1671+
- <code title="get /zones/{zone_id}/dns_records">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">list</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_list_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/dns_record.py">SyncV4PagePaginationArray[DNSRecord]</a></code>
16841672
- <code title="delete /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">delete</a>(dns_record_id, \*, zone_id) -> <a href="./src/cloudflare/types/dns/record_delete_response.py">Optional</a></code>
1685-
- <code title="patch /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">edit</a>(dns_record_id, \*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/record_edit_response.py">RecordEditResponse</a></code>
1673+
- <code title="patch /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">edit</a>(dns_record_id, \*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/dns_record.py">DNSRecord</a></code>
16861674
- <code title="get /zones/{zone_id}/dns_records/export">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">export</a>(\*, zone_id) -> str</code>
1687-
- <code title="get /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">get</a>(dns_record_id, \*, zone_id) -> <a href="./src/cloudflare/types/dns/record_get_response.py">RecordGetResponse</a></code>
1675+
- <code title="get /zones/{zone_id}/dns_records/{dns_record_id}">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">get</a>(dns_record_id, \*, zone_id) -> <a href="./src/cloudflare/types/dns/dns_record.py">DNSRecord</a></code>
16881676
- <code title="post /zones/{zone_id}/dns_records/import">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">import\_</a>(\*, zone_id, \*\*<a href="src/cloudflare/types/dns/record_import_params.py">params</a>) -> <a href="./src/cloudflare/types/dns/record_import_response.py">RecordImportResponse</a></code>
16891677
- <code title="post /zones/{zone_id}/dns_records/scan">client.dns.records.<a href="./src/cloudflare/resources/dns/records.py">scan</a>(\*, zone_id) -> <a href="./src/cloudflare/types/dns/record_scan_response.py">RecordScanResponse</a></code>
16901678

src/cloudflare/resources/dns/records.py

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,10 @@
2222
)
2323
from ..._wrappers import ResultWrapper
2424
from ...types.dns import (
25-
RecordGetResponse,
26-
RecordEditResponse,
27-
RecordListResponse,
25+
DNSRecord,
2826
RecordScanResponse,
29-
RecordCreateResponse,
3027
RecordDeleteResponse,
3128
RecordImportResponse,
32-
RecordUpdateResponse,
3329
record_edit_params,
3430
record_list_params,
3531
record_create_params,
@@ -95,7 +91,7 @@ def create(
9591
extra_query: Query | None = None,
9692
extra_body: Body | None = None,
9793
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
98-
) -> RecordCreateResponse:
94+
) -> DNSRecord:
9995
"""
10096
Create a new DNS record for a zone.
10197
@@ -141,7 +137,7 @@ def create(
141137
if not zone_id:
142138
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
143139
return cast(
144-
RecordCreateResponse,
140+
DNSRecord,
145141
self._post(
146142
f"/zones/{zone_id}/dns_records",
147143
body=maybe_transform(
@@ -167,7 +163,7 @@ def create(
167163
post_parser=ResultWrapper._unwrapper,
168164
),
169165
cast_to=cast(
170-
Any, ResultWrapper[RecordCreateResponse]
166+
Any, ResultWrapper[DNSRecord]
171167
), # Union types cannot be passed in as arguments in the type system
172168
),
173169
)
@@ -214,7 +210,7 @@ def update(
214210
extra_query: Query | None = None,
215211
extra_body: Body | None = None,
216212
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
217-
) -> RecordUpdateResponse:
213+
) -> DNSRecord:
218214
"""Overwrite an existing DNS record.
219215
220216
Notes:
@@ -263,7 +259,7 @@ def update(
263259
if not dns_record_id:
264260
raise ValueError(f"Expected a non-empty value for `dns_record_id` but received {dns_record_id!r}")
265261
return cast(
266-
RecordUpdateResponse,
262+
DNSRecord,
267263
self._put(
268264
f"/zones/{zone_id}/dns_records/{dns_record_id}",
269265
body=maybe_transform(
@@ -289,7 +285,7 @@ def update(
289285
post_parser=ResultWrapper._unwrapper,
290286
),
291287
cast_to=cast(
292-
Any, ResultWrapper[RecordUpdateResponse]
288+
Any, ResultWrapper[DNSRecord]
293289
), # Union types cannot be passed in as arguments in the type system
294290
),
295291
)
@@ -339,7 +335,7 @@ def list(
339335
extra_query: Query | None = None,
340336
extra_body: Body | None = None,
341337
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
342-
) -> SyncV4PagePaginationArray[RecordListResponse]:
338+
) -> SyncV4PagePaginationArray[DNSRecord]:
343339
"""
344340
List, search, sort, and filter a zones' DNS records.
345341
@@ -391,7 +387,7 @@ def list(
391387
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
392388
return self._get_api_list(
393389
f"/zones/{zone_id}/dns_records",
394-
page=SyncV4PagePaginationArray[RecordListResponse],
390+
page=SyncV4PagePaginationArray[DNSRecord],
395391
options=make_request_options(
396392
extra_headers=extra_headers,
397393
extra_query=extra_query,
@@ -416,7 +412,7 @@ def list(
416412
record_list_params.RecordListParams,
417413
),
418414
),
419-
model=cast(Any, RecordListResponse), # Union types cannot be passed in as arguments in the type system
415+
model=cast(Any, DNSRecord), # Union types cannot be passed in as arguments in the type system
420416
)
421417

422418
def delete(
@@ -505,7 +501,7 @@ def edit(
505501
extra_query: Query | None = None,
506502
extra_body: Body | None = None,
507503
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
508-
) -> RecordEditResponse:
504+
) -> DNSRecord:
509505
"""Update an existing DNS record.
510506
511507
Notes:
@@ -554,7 +550,7 @@ def edit(
554550
if not dns_record_id:
555551
raise ValueError(f"Expected a non-empty value for `dns_record_id` but received {dns_record_id!r}")
556552
return cast(
557-
RecordEditResponse,
553+
DNSRecord,
558554
self._patch(
559555
f"/zones/{zone_id}/dns_records/{dns_record_id}",
560556
body=maybe_transform(
@@ -580,7 +576,7 @@ def edit(
580576
post_parser=ResultWrapper._unwrapper,
581577
),
582578
cast_to=cast(
583-
Any, ResultWrapper[RecordEditResponse]
579+
Any, ResultWrapper[DNSRecord]
584580
), # Union types cannot be passed in as arguments in the type system
585581
),
586582
)
@@ -638,7 +634,7 @@ def get(
638634
extra_query: Query | None = None,
639635
extra_body: Body | None = None,
640636
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
641-
) -> RecordGetResponse:
637+
) -> DNSRecord:
642638
"""
643639
DNS Record Details
644640
@@ -660,7 +656,7 @@ def get(
660656
if not dns_record_id:
661657
raise ValueError(f"Expected a non-empty value for `dns_record_id` but received {dns_record_id!r}")
662658
return cast(
663-
RecordGetResponse,
659+
DNSRecord,
664660
self._get(
665661
f"/zones/{zone_id}/dns_records/{dns_record_id}",
666662
options=make_request_options(
@@ -671,7 +667,7 @@ def get(
671667
post_parser=ResultWrapper._unwrapper,
672668
),
673669
cast_to=cast(
674-
Any, ResultWrapper[RecordGetResponse]
670+
Any, ResultWrapper[DNSRecord]
675671
), # Union types cannot be passed in as arguments in the type system
676672
),
677673
)
@@ -832,7 +828,7 @@ async def create(
832828
extra_query: Query | None = None,
833829
extra_body: Body | None = None,
834830
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
835-
) -> RecordCreateResponse:
831+
) -> DNSRecord:
836832
"""
837833
Create a new DNS record for a zone.
838834
@@ -878,7 +874,7 @@ async def create(
878874
if not zone_id:
879875
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
880876
return cast(
881-
RecordCreateResponse,
877+
DNSRecord,
882878
await self._post(
883879
f"/zones/{zone_id}/dns_records",
884880
body=await async_maybe_transform(
@@ -904,7 +900,7 @@ async def create(
904900
post_parser=ResultWrapper._unwrapper,
905901
),
906902
cast_to=cast(
907-
Any, ResultWrapper[RecordCreateResponse]
903+
Any, ResultWrapper[DNSRecord]
908904
), # Union types cannot be passed in as arguments in the type system
909905
),
910906
)
@@ -951,7 +947,7 @@ async def update(
951947
extra_query: Query | None = None,
952948
extra_body: Body | None = None,
953949
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
954-
) -> RecordUpdateResponse:
950+
) -> DNSRecord:
955951
"""Overwrite an existing DNS record.
956952
957953
Notes:
@@ -1000,7 +996,7 @@ async def update(
1000996
if not dns_record_id:
1001997
raise ValueError(f"Expected a non-empty value for `dns_record_id` but received {dns_record_id!r}")
1002998
return cast(
1003-
RecordUpdateResponse,
999+
DNSRecord,
10041000
await self._put(
10051001
f"/zones/{zone_id}/dns_records/{dns_record_id}",
10061002
body=await async_maybe_transform(
@@ -1026,7 +1022,7 @@ async def update(
10261022
post_parser=ResultWrapper._unwrapper,
10271023
),
10281024
cast_to=cast(
1029-
Any, ResultWrapper[RecordUpdateResponse]
1025+
Any, ResultWrapper[DNSRecord]
10301026
), # Union types cannot be passed in as arguments in the type system
10311027
),
10321028
)
@@ -1076,7 +1072,7 @@ def list(
10761072
extra_query: Query | None = None,
10771073
extra_body: Body | None = None,
10781074
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1079-
) -> AsyncPaginator[RecordListResponse, AsyncV4PagePaginationArray[RecordListResponse]]:
1075+
) -> AsyncPaginator[DNSRecord, AsyncV4PagePaginationArray[DNSRecord]]:
10801076
"""
10811077
List, search, sort, and filter a zones' DNS records.
10821078
@@ -1128,7 +1124,7 @@ def list(
11281124
raise ValueError(f"Expected a non-empty value for `zone_id` but received {zone_id!r}")
11291125
return self._get_api_list(
11301126
f"/zones/{zone_id}/dns_records",
1131-
page=AsyncV4PagePaginationArray[RecordListResponse],
1127+
page=AsyncV4PagePaginationArray[DNSRecord],
11321128
options=make_request_options(
11331129
extra_headers=extra_headers,
11341130
extra_query=extra_query,
@@ -1153,7 +1149,7 @@ def list(
11531149
record_list_params.RecordListParams,
11541150
),
11551151
),
1156-
model=cast(Any, RecordListResponse), # Union types cannot be passed in as arguments in the type system
1152+
model=cast(Any, DNSRecord), # Union types cannot be passed in as arguments in the type system
11571153
)
11581154

11591155
async def delete(
@@ -1242,7 +1238,7 @@ async def edit(
12421238
extra_query: Query | None = None,
12431239
extra_body: Body | None = None,
12441240
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1245-
) -> RecordEditResponse:
1241+
) -> DNSRecord:
12461242
"""Update an existing DNS record.
12471243
12481244
Notes:
@@ -1291,7 +1287,7 @@ async def edit(
12911287
if not dns_record_id:
12921288
raise ValueError(f"Expected a non-empty value for `dns_record_id` but received {dns_record_id!r}")
12931289
return cast(
1294-
RecordEditResponse,
1290+
DNSRecord,
12951291
await self._patch(
12961292
f"/zones/{zone_id}/dns_records/{dns_record_id}",
12971293
body=await async_maybe_transform(
@@ -1317,7 +1313,7 @@ async def edit(
13171313
post_parser=ResultWrapper._unwrapper,
13181314
),
13191315
cast_to=cast(
1320-
Any, ResultWrapper[RecordEditResponse]
1316+
Any, ResultWrapper[DNSRecord]
13211317
), # Union types cannot be passed in as arguments in the type system
13221318
),
13231319
)
@@ -1375,7 +1371,7 @@ async def get(
13751371
extra_query: Query | None = None,
13761372
extra_body: Body | None = None,
13771373
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1378-
) -> RecordGetResponse:
1374+
) -> DNSRecord:
13791375
"""
13801376
DNS Record Details
13811377
@@ -1397,7 +1393,7 @@ async def get(
13971393
if not dns_record_id:
13981394
raise ValueError(f"Expected a non-empty value for `dns_record_id` but received {dns_record_id!r}")
13991395
return cast(
1400-
RecordGetResponse,
1396+
DNSRecord,
14011397
await self._get(
14021398
f"/zones/{zone_id}/dns_records/{dns_record_id}",
14031399
options=make_request_options(
@@ -1408,7 +1404,7 @@ async def get(
14081404
post_parser=ResultWrapper._unwrapper,
14091405
),
14101406
cast_to=cast(
1411-
Any, ResultWrapper[RecordGetResponse]
1407+
Any, ResultWrapper[DNSRecord]
14121408
), # Union types cannot be passed in as arguments in the type system
14131409
),
14141410
)

0 commit comments

Comments
 (0)