Skip to content

Commit 3c1de95

Browse files
stainless-app[bot]stainless-bot
authored andcommitted
feat(api): update via SDK Studio (#156)
1 parent efaad20 commit 3c1de95

15 files changed

+91
-56
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,41 @@ with client.zones.with_streaming_response.create(
306306

307307
The context manager is required so that the response will reliably be closed.
308308

309+
### Making custom/undocumented requests
310+
311+
This library is typed for convenient access the documented API.
312+
313+
If you need to access undocumented endpoints, params, or response properties, the library can still be used.
314+
315+
#### Undocumented endpoints
316+
317+
To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
318+
http verbs. Options on the client will be respected (such as retries) will be respected when making this
319+
request.
320+
321+
```py
322+
import httpx
323+
324+
response = client.post(
325+
"/foo",
326+
cast_to=httpx.Response,
327+
body={"my_param": True},
328+
)
329+
330+
print(response.headers.get("x-foo"))
331+
```
332+
333+
#### Undocumented params
334+
335+
If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
336+
options.
337+
338+
#### Undocumented properties
339+
340+
To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
341+
can also get all the extra fields on the Pydantic model as a dict with
342+
[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
343+
309344
### Configuring the HTTP client
310345

311346
You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:

src/cloudflare/types/dns/dns_record.py

+17-17
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
"CAA",
1717
"CAAData",
1818
"CAAMeta",
19-
"Cert",
20-
"CertData",
21-
"CertMeta",
19+
"CERT",
20+
"CERTData",
21+
"CERTMeta",
2222
"CNAME",
2323
"CNAMEMeta",
2424
"DNSKEY",
@@ -42,9 +42,9 @@
4242
"NSMeta",
4343
"PTR",
4444
"PTRMeta",
45-
"Smimea",
46-
"SmimeaData",
47-
"SmimeaMeta",
45+
"SMIMEA",
46+
"SMIMEAData",
47+
"SMIMEAMeta",
4848
"SRV",
4949
"SRVData",
5050
"SRVMeta",
@@ -286,7 +286,7 @@ class CAA(BaseModel):
286286
"""The domain of the record."""
287287

288288

289-
class CertData(BaseModel):
289+
class CERTData(BaseModel):
290290
algorithm: Optional[float] = None
291291
"""Algorithm."""
292292

@@ -300,7 +300,7 @@ class CertData(BaseModel):
300300
"""Type."""
301301

302302

303-
class CertMeta(BaseModel):
303+
class CERTMeta(BaseModel):
304304
auto_added: Optional[bool] = None
305305
"""
306306
Will exist if Cloudflare automatically added this DNS record during initial
@@ -311,8 +311,8 @@ class CertMeta(BaseModel):
311311
"""Where the record originated from."""
312312

313313

314-
class Cert(BaseModel):
315-
data: CertData
314+
class CERT(BaseModel):
315+
data: CERTData
316316
"""Components of a CERT record."""
317317

318318
name: str
@@ -342,7 +342,7 @@ class Cert(BaseModel):
342342
Cloudflare).
343343
"""
344344

345-
meta: Optional[CertMeta] = None
345+
meta: Optional[CERTMeta] = None
346346
"""Extra Cloudflare-specific information about the record."""
347347

348348
modified_on: Optional[datetime] = None
@@ -1077,7 +1077,7 @@ class PTR(BaseModel):
10771077
"""The domain of the record."""
10781078

10791079

1080-
class SmimeaData(BaseModel):
1080+
class SMIMEAData(BaseModel):
10811081
certificate: Optional[str] = None
10821082
"""Certificate."""
10831083

@@ -1091,7 +1091,7 @@ class SmimeaData(BaseModel):
10911091
"""Usage."""
10921092

10931093

1094-
class SmimeaMeta(BaseModel):
1094+
class SMIMEAMeta(BaseModel):
10951095
auto_added: Optional[bool] = None
10961096
"""
10971097
Will exist if Cloudflare automatically added this DNS record during initial
@@ -1102,8 +1102,8 @@ class SmimeaMeta(BaseModel):
11021102
"""Where the record originated from."""
11031103

11041104

1105-
class Smimea(BaseModel):
1106-
data: SmimeaData
1105+
class SMIMEA(BaseModel):
1106+
data: SMIMEAData
11071107
"""Components of a SMIMEA record."""
11081108

11091109
name: str
@@ -1133,7 +1133,7 @@ class Smimea(BaseModel):
11331133
Cloudflare).
11341134
"""
11351135

1136-
meta: Optional[SmimeaMeta] = None
1136+
meta: Optional[SMIMEAMeta] = None
11371137
"""Extra Cloudflare-specific information about the record."""
11381138

11391139
modified_on: Optional[datetime] = None
@@ -1662,7 +1662,7 @@ class URI(BaseModel):
16621662

16631663
DNSRecord = Annotated[
16641664
Union[
1665-
A, AAAA, CAA, Cert, CNAME, DNSKEY, DS, HTTPS, LOC, MX, NAPTR, NS, PTR, Smimea, SRV, SSHFP, SVCB, TLSA, TXT, URI
1665+
A, AAAA, CAA, CERT, CNAME, DNSKEY, DS, HTTPS, LOC, MX, NAPTR, NS, PTR, SMIMEA, SRV, SSHFP, SVCB, TLSA, TXT, URI
16661666
],
16671667
PropertyInfo(discriminator="type"),
16681668
]

src/cloudflare/types/workers/scripts/setting_edit_params.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"SettingsResultBindingWorkersDispatchNamespaceBinding",
2222
"SettingsResultBindingWorkersDispatchNamespaceBindingOutbound",
2323
"SettingsResultBindingWorkersDispatchNamespaceBindingOutboundWorker",
24-
"SettingsResultBindingWorkersMTLSCertBinding",
24+
"SettingsResultBindingWorkersMTLSCERTBinding",
2525
"SettingsResultMigrations",
2626
"SettingsResultMigrationsWorkersSingleStepMigrations",
2727
"SettingsResultMigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -143,7 +143,7 @@ class SettingsResultBindingWorkersDispatchNamespaceBinding(TypedDict, total=Fals
143143
"""Outbound worker"""
144144

145145

146-
class SettingsResultBindingWorkersMTLSCertBinding(TypedDict, total=False):
146+
class SettingsResultBindingWorkersMTLSCERTBinding(TypedDict, total=False):
147147
type: Required[Literal["mtls_certificate"]]
148148
"""The class of resource that the binding provides."""
149149

@@ -159,7 +159,7 @@ class SettingsResultBindingWorkersMTLSCertBinding(TypedDict, total=False):
159159
SettingsResultBindingWorkersQueueBinding,
160160
SettingsResultBindingWorkersD1Binding,
161161
SettingsResultBindingWorkersDispatchNamespaceBinding,
162-
SettingsResultBindingWorkersMTLSCertBinding,
162+
SettingsResultBindingWorkersMTLSCERTBinding,
163163
]
164164

165165
_SettingsResultMigrationsWorkersSingleStepMigrationsRenamedClassReservedKeywords = TypedDict(

src/cloudflare/types/workers/scripts/setting_edit_response.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"BindingWorkersDispatchNamespaceBinding",
2020
"BindingWorkersDispatchNamespaceBindingOutbound",
2121
"BindingWorkersDispatchNamespaceBindingOutboundWorker",
22-
"BindingWorkersMTLSCertBinding",
22+
"BindingWorkersMTLSCERTBinding",
2323
"Migrations",
2424
"MigrationsWorkersSingleStepMigrations",
2525
"MigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -149,7 +149,7 @@ class BindingWorkersDispatchNamespaceBinding(BaseModel):
149149
"""Outbound worker"""
150150

151151

152-
class BindingWorkersMTLSCertBinding(BaseModel):
152+
class BindingWorkersMTLSCERTBinding(BaseModel):
153153
name: str
154154
"""A JavaScript variable name for the binding."""
155155

@@ -168,7 +168,7 @@ class BindingWorkersMTLSCertBinding(BaseModel):
168168
BindingWorkersQueueBinding,
169169
BindingWorkersD1Binding,
170170
BindingWorkersDispatchNamespaceBinding,
171-
BindingWorkersMTLSCertBinding,
171+
BindingWorkersMTLSCERTBinding,
172172
]
173173

174174

src/cloudflare/types/workers/scripts/setting_get_response.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"BindingWorkersDispatchNamespaceBinding",
2020
"BindingWorkersDispatchNamespaceBindingOutbound",
2121
"BindingWorkersDispatchNamespaceBindingOutboundWorker",
22-
"BindingWorkersMTLSCertBinding",
22+
"BindingWorkersMTLSCERTBinding",
2323
"Migrations",
2424
"MigrationsWorkersSingleStepMigrations",
2525
"MigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -149,7 +149,7 @@ class BindingWorkersDispatchNamespaceBinding(BaseModel):
149149
"""Outbound worker"""
150150

151151

152-
class BindingWorkersMTLSCertBinding(BaseModel):
152+
class BindingWorkersMTLSCERTBinding(BaseModel):
153153
name: str
154154
"""A JavaScript variable name for the binding."""
155155

@@ -168,7 +168,7 @@ class BindingWorkersMTLSCertBinding(BaseModel):
168168
BindingWorkersQueueBinding,
169169
BindingWorkersD1Binding,
170170
BindingWorkersDispatchNamespaceBinding,
171-
BindingWorkersMTLSCertBinding,
171+
BindingWorkersMTLSCERTBinding,
172172
]
173173

174174

src/cloudflare/types/workers/services/environments/setting_edit_params.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"ResultBindingWorkersDispatchNamespaceBinding",
2121
"ResultBindingWorkersDispatchNamespaceBindingOutbound",
2222
"ResultBindingWorkersDispatchNamespaceBindingOutboundWorker",
23-
"ResultBindingWorkersMTLSCertBinding",
23+
"ResultBindingWorkersMTLSCERTBinding",
2424
"ResultMigrations",
2525
"ResultMigrationsWorkersSingleStepMigrations",
2626
"ResultMigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -152,7 +152,7 @@ class ResultBindingWorkersDispatchNamespaceBinding(TypedDict, total=False):
152152
"""Outbound worker"""
153153

154154

155-
class ResultBindingWorkersMTLSCertBinding(TypedDict, total=False):
155+
class ResultBindingWorkersMTLSCERTBinding(TypedDict, total=False):
156156
type: Required[Literal["mtls_certificate"]]
157157
"""The class of resource that the binding provides."""
158158

@@ -168,7 +168,7 @@ class ResultBindingWorkersMTLSCertBinding(TypedDict, total=False):
168168
ResultBindingWorkersQueueBinding,
169169
ResultBindingWorkersD1Binding,
170170
ResultBindingWorkersDispatchNamespaceBinding,
171-
ResultBindingWorkersMTLSCertBinding,
171+
ResultBindingWorkersMTLSCERTBinding,
172172
]
173173

174174
_ResultMigrationsWorkersSingleStepMigrationsRenamedClassReservedKeywords = TypedDict(

src/cloudflare/types/workers/services/environments/setting_edit_response.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"BindingWorkersDispatchNamespaceBinding",
2020
"BindingWorkersDispatchNamespaceBindingOutbound",
2121
"BindingWorkersDispatchNamespaceBindingOutboundWorker",
22-
"BindingWorkersMTLSCertBinding",
22+
"BindingWorkersMTLSCERTBinding",
2323
"Migrations",
2424
"MigrationsWorkersSingleStepMigrations",
2525
"MigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -149,7 +149,7 @@ class BindingWorkersDispatchNamespaceBinding(BaseModel):
149149
"""Outbound worker"""
150150

151151

152-
class BindingWorkersMTLSCertBinding(BaseModel):
152+
class BindingWorkersMTLSCERTBinding(BaseModel):
153153
name: str
154154
"""A JavaScript variable name for the binding."""
155155

@@ -168,7 +168,7 @@ class BindingWorkersMTLSCertBinding(BaseModel):
168168
BindingWorkersQueueBinding,
169169
BindingWorkersD1Binding,
170170
BindingWorkersDispatchNamespaceBinding,
171-
BindingWorkersMTLSCertBinding,
171+
BindingWorkersMTLSCERTBinding,
172172
]
173173

174174

src/cloudflare/types/workers/services/environments/setting_get_response.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"BindingWorkersDispatchNamespaceBinding",
2020
"BindingWorkersDispatchNamespaceBindingOutbound",
2121
"BindingWorkersDispatchNamespaceBindingOutboundWorker",
22-
"BindingWorkersMTLSCertBinding",
22+
"BindingWorkersMTLSCERTBinding",
2323
"Migrations",
2424
"MigrationsWorkersSingleStepMigrations",
2525
"MigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -149,7 +149,7 @@ class BindingWorkersDispatchNamespaceBinding(BaseModel):
149149
"""Outbound worker"""
150150

151151

152-
class BindingWorkersMTLSCertBinding(BaseModel):
152+
class BindingWorkersMTLSCERTBinding(BaseModel):
153153
name: str
154154
"""A JavaScript variable name for the binding."""
155155

@@ -168,7 +168,7 @@ class BindingWorkersMTLSCertBinding(BaseModel):
168168
BindingWorkersQueueBinding,
169169
BindingWorkersD1Binding,
170170
BindingWorkersDispatchNamespaceBinding,
171-
BindingWorkersMTLSCertBinding,
171+
BindingWorkersMTLSCERTBinding,
172172
]
173173

174174

src/cloudflare/types/workers_for_platforms/dispatch/namespaces/scripts/content/binding_get_response.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"WorkersDispatchNamespaceBinding",
1717
"WorkersDispatchNamespaceBindingOutbound",
1818
"WorkersDispatchNamespaceBindingOutboundWorker",
19-
"WorkersMTLSCertBinding",
19+
"WorkersMTLSCERTBinding",
2020
]
2121

2222

@@ -136,7 +136,7 @@ class WorkersDispatchNamespaceBinding(BaseModel):
136136
"""Outbound worker"""
137137

138138

139-
class WorkersMTLSCertBinding(BaseModel):
139+
class WorkersMTLSCERTBinding(BaseModel):
140140
name: str
141141
"""A JavaScript variable name for the binding."""
142142

@@ -155,5 +155,5 @@ class WorkersMTLSCertBinding(BaseModel):
155155
WorkersQueueBinding,
156156
WorkersD1Binding,
157157
WorkersDispatchNamespaceBinding,
158-
WorkersMTLSCertBinding,
158+
WorkersMTLSCERTBinding,
159159
]

src/cloudflare/types/workers_for_platforms/dispatch/namespaces/scripts/content/setting_edit_params.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"ResultBindingWorkersDispatchNamespaceBinding",
2121
"ResultBindingWorkersDispatchNamespaceBindingOutbound",
2222
"ResultBindingWorkersDispatchNamespaceBindingOutboundWorker",
23-
"ResultBindingWorkersMTLSCertBinding",
23+
"ResultBindingWorkersMTLSCERTBinding",
2424
"ResultMigrations",
2525
"ResultMigrationsWorkersSingleStepMigrations",
2626
"ResultMigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -152,7 +152,7 @@ class ResultBindingWorkersDispatchNamespaceBinding(TypedDict, total=False):
152152
"""Outbound worker"""
153153

154154

155-
class ResultBindingWorkersMTLSCertBinding(TypedDict, total=False):
155+
class ResultBindingWorkersMTLSCERTBinding(TypedDict, total=False):
156156
type: Required[Literal["mtls_certificate"]]
157157
"""The class of resource that the binding provides."""
158158

@@ -168,7 +168,7 @@ class ResultBindingWorkersMTLSCertBinding(TypedDict, total=False):
168168
ResultBindingWorkersQueueBinding,
169169
ResultBindingWorkersD1Binding,
170170
ResultBindingWorkersDispatchNamespaceBinding,
171-
ResultBindingWorkersMTLSCertBinding,
171+
ResultBindingWorkersMTLSCERTBinding,
172172
]
173173

174174
_ResultMigrationsWorkersSingleStepMigrationsRenamedClassReservedKeywords = TypedDict(

src/cloudflare/types/workers_for_platforms/dispatch/namespaces/scripts/content/setting_edit_response.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"BindingWorkersDispatchNamespaceBinding",
2020
"BindingWorkersDispatchNamespaceBindingOutbound",
2121
"BindingWorkersDispatchNamespaceBindingOutboundWorker",
22-
"BindingWorkersMTLSCertBinding",
22+
"BindingWorkersMTLSCERTBinding",
2323
"Migrations",
2424
"MigrationsWorkersSingleStepMigrations",
2525
"MigrationsWorkersSingleStepMigrationsRenamedClass",
@@ -149,7 +149,7 @@ class BindingWorkersDispatchNamespaceBinding(BaseModel):
149149
"""Outbound worker"""
150150

151151

152-
class BindingWorkersMTLSCertBinding(BaseModel):
152+
class BindingWorkersMTLSCERTBinding(BaseModel):
153153
name: str
154154
"""A JavaScript variable name for the binding."""
155155

@@ -168,7 +168,7 @@ class BindingWorkersMTLSCertBinding(BaseModel):
168168
BindingWorkersQueueBinding,
169169
BindingWorkersD1Binding,
170170
BindingWorkersDispatchNamespaceBinding,
171-
BindingWorkersMTLSCertBinding,
171+
BindingWorkersMTLSCERTBinding,
172172
]
173173

174174

0 commit comments

Comments
 (0)