Skip to content

Commit 72eb205

Browse files
chore(api): update composite API spec
1 parent 86bdf98 commit 72eb205

78 files changed

Lines changed: 1033 additions & 470 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 2376
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-f63166c7c5fb3e729ec074f8dc759d35278ec33e71d77f31b2ccbfd9bf139b64.yml
3-
openapi_spec_hash: 8f069d1e288250bf1dcb466b696cd11c
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-514c439211d08727278b25d13388b711bf1e431382b55eeb10079db550d01fa3.yml
3+
openapi_spec_hash: c5f909ea82142fc11cd786fb212209fa
44
config_hash: ec0647c69ef9d049d1e12e9ddb0673ee

src/cloudflare/resources/browser_rendering/devtools/browser/browser.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def create(
8484
timeout: float | httpx.Timeout | None | NotGiven = not_given,
8585
) -> BrowserCreateResponse:
8686
"""
87-
Get a browser session ID.
87+
Acquire a new browser DevTools session
8888
8989
Args:
9090
account_id: Account ID.
@@ -420,7 +420,7 @@ async def create(
420420
timeout: float | httpx.Timeout | None | NotGiven = not_given,
421421
) -> BrowserCreateResponse:
422422
"""
423-
Get a browser session ID.
423+
Acquire a new browser DevTools session
424424
425425
Args:
426426
account_id: Account ID.

src/cloudflare/resources/custom_hostnames/custom_hostnames.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,8 @@ def list(
216216
217217
id: Hostname ID to match against. This ID was generated and returned during the
218218
initial custom_hostname creation. This parameter cannot be used with the
219-
'hostname' parameter.
219+
'hostname', 'hostname.exact', 'hostname.contain', or 'hostname.startsWith'
220+
parameters.
220221
221222
certificate_authority: Filter by the certificate authority that issued the SSL certificate.
222223
@@ -620,7 +621,8 @@ def list(
620621
621622
id: Hostname ID to match against. This ID was generated and returned during the
622623
initial custom_hostname creation. This parameter cannot be used with the
623-
'hostname' parameter.
624+
'hostname', 'hostname.exact', 'hostname.contain', or 'hostname.startsWith'
625+
parameters.
624626
625627
certificate_authority: Filter by the certificate authority that issued the SSL certificate.
626628

src/cloudflare/resources/zero_trust/devices/dex_tests.py

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ def create(
7272
Create a DEX test.
7373
7474
Args:
75+
account_id: Unique identifier linked to an account.
76+
7577
data: The configuration object which contains the details for the WARP client to
7678
conduct the test.
7779
@@ -142,6 +144,8 @@ def update(
142144
Update a DEX test.
143145
144146
Args:
147+
account_id: Unique identifier linked to an account.
148+
145149
dex_test_id: API Resource UUID tag.
146150
147151
data: The configuration object which contains the details for the WARP client to
@@ -213,16 +217,18 @@ def list(
213217
timeout: float | httpx.Timeout | None | NotGiven = not_given,
214218
) -> SyncV4PagePaginationArray[DEXTestListResponse]:
215219
"""
216-
Fetch all DEX tests
220+
Fetch all DEX tests.
217221
218222
Args:
219-
kind: Filter by test type
223+
account_id: Unique identifier linked to an account.
224+
225+
kind: Filter by test type.
220226
221-
page: Page number of paginated results
227+
page: Page number of paginated results.
222228
223-
per_page: Number of items per page
229+
per_page: Number of results per page.
224230
225-
test_name: Filter by test name
231+
test_name: Filter by test name.
226232
227233
extra_headers: Send extra headers
228234
@@ -273,6 +279,8 @@ def delete(
273279
account.
274280
275281
Args:
282+
account_id: Unique identifier linked to an account.
283+
276284
dex_test_id: API Resource UUID tag.
277285
278286
extra_headers: Send extra headers
@@ -319,6 +327,8 @@ def get(
319327
Fetch a single DEX test.
320328
321329
Args:
330+
account_id: Unique identifier linked to an account.
331+
322332
dex_test_id: The unique identifier for the test.
323333
324334
extra_headers: Send extra headers
@@ -392,6 +402,8 @@ async def create(
392402
Create a DEX test.
393403
394404
Args:
405+
account_id: Unique identifier linked to an account.
406+
395407
data: The configuration object which contains the details for the WARP client to
396408
conduct the test.
397409
@@ -462,6 +474,8 @@ async def update(
462474
Update a DEX test.
463475
464476
Args:
477+
account_id: Unique identifier linked to an account.
478+
465479
dex_test_id: API Resource UUID tag.
466480
467481
data: The configuration object which contains the details for the WARP client to
@@ -533,16 +547,18 @@ def list(
533547
timeout: float | httpx.Timeout | None | NotGiven = not_given,
534548
) -> AsyncPaginator[DEXTestListResponse, AsyncV4PagePaginationArray[DEXTestListResponse]]:
535549
"""
536-
Fetch all DEX tests
550+
Fetch all DEX tests.
537551
538552
Args:
539-
kind: Filter by test type
553+
account_id: Unique identifier linked to an account.
554+
555+
kind: Filter by test type.
540556
541-
page: Page number of paginated results
557+
page: Page number of paginated results.
542558
543-
per_page: Number of items per page
559+
per_page: Number of results per page.
544560
545-
test_name: Filter by test name
561+
test_name: Filter by test name.
546562
547563
extra_headers: Send extra headers
548564
@@ -593,6 +609,8 @@ async def delete(
593609
account.
594610
595611
Args:
612+
account_id: Unique identifier linked to an account.
613+
596614
dex_test_id: API Resource UUID tag.
597615
598616
extra_headers: Send extra headers
@@ -639,6 +657,8 @@ async def get(
639657
Fetch a single DEX test.
640658
641659
Args:
660+
account_id: Unique identifier linked to an account.
661+
642662
dex_test_id: The unique identifier for the test.
643663
644664
extra_headers: Send extra headers

src/cloudflare/resources/zero_trust/devices/fleet_status.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,15 @@ def get(
6161
table
6262
6363
Args:
64-
device_id: Device-specific ID, given as UUID v4
64+
account_id: Unique identifier linked to an account.
6565
66-
since_minutes: Number of minutes before current time
66+
device_id: Unique identifier for the physical device (UUID).
6767
68-
colo: List of data centers to filter results
68+
since_minutes: Number of minutes before current time.
6969
70-
time_now: Number of minutes before current time
70+
colo: List of data centers to filter results.
71+
72+
time_now: Current time in ISO format.
7173
7274
extra_headers: Send extra headers
7375
@@ -145,13 +147,15 @@ async def get(
145147
table
146148
147149
Args:
148-
device_id: Device-specific ID, given as UUID v4
150+
account_id: Unique identifier linked to an account.
151+
152+
device_id: Unique identifier for the physical device (UUID).
149153
150-
since_minutes: Number of minutes before current time
154+
since_minutes: Number of minutes before current time.
151155
152-
colo: List of data centers to filter results
156+
colo: List of data centers to filter results.
153157
154-
time_now: Number of minutes before current time
158+
time_now: Current time in ISO format.
155159
156160
extra_headers: Send extra headers
157161

src/cloudflare/resources/zero_trust/dex/colos.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,11 @@ def list(
6464
are also returned and sorted alphabetically.
6565
6666
Args:
67-
from_: Start time for connection period in ISO (RFC3339 - ISO 8601) format
67+
account_id: Unique identifier linked to an account.
6868
69-
to: End time for connection period in ISO (RFC3339 - ISO 8601) format
69+
from_: Start time for connection period in ISO (RFC3339 - ISO 8601) format.
70+
71+
to: End time for connection period in ISO (RFC3339 - ISO 8601) format.
7072
7173
sort_by: Type of usage that colos should be sorted by. If unspecified, returns all
7274
Cloudflare colos sorted alphabetically.
@@ -142,9 +144,11 @@ def list(
142144
are also returned and sorted alphabetically.
143145
144146
Args:
145-
from_: Start time for connection period in ISO (RFC3339 - ISO 8601) format
147+
account_id: Unique identifier linked to an account.
148+
149+
from_: Start time for connection period in ISO (RFC3339 - ISO 8601) format.
146150
147-
to: End time for connection period in ISO (RFC3339 - ISO 8601) format
151+
to: End time for connection period in ISO (RFC3339 - ISO 8601) format.
148152
149153
sort_by: Type of usage that colos should be sorted by. If unspecified, returns all
150154
Cloudflare colos sorted alphabetically.

src/cloudflare/resources/zero_trust/dex/commands/commands.py

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,11 @@ def create(
9797
timeout: float | httpx.Timeout | None | NotGiven = not_given,
9898
) -> Optional[CommandCreateResponse]:
9999
"""
100-
Initiate commands for up to 10 devices per account
100+
Initiate commands for up to 10 devices per account.
101101
102102
Args:
103+
account_id: Unique identifier linked to an account.
104+
103105
commands: List of device-level commands to execute
104106
105107
extra_headers: Send extra headers
@@ -149,21 +151,23 @@ def list(
149151
account, optionally filtered by time range, device, or other parameters
150152
151153
Args:
152-
page: Page number for pagination
154+
account_id: Unique identifier linked to an account.
155+
156+
page: Page number of paginated results.
153157
154-
per_page: Number of results per page
158+
per_page: Number of results per page.
155159
156-
command_type: Optionally filter executed commands by command type
160+
command_type: Optionally filter executed commands by command type.
157161
158-
device_id: Unique identifier for a device
162+
device_id: Unique identifier for a device.
159163
160-
from_: Start time for the query in ISO (RFC3339 - ISO 8601) format
164+
from_: Start time for the query in ISO (RFC3339 - ISO 8601) format.
161165
162-
status: Optionally filter executed commands by status
166+
status: Optionally filter executed commands by status.
163167
164-
to: End time for the query in ISO (RFC3339 - ISO 8601) format
168+
to: End time for the query in ISO (RFC3339 - ISO 8601) format.
165169
166-
user_email: Email tied to the device
170+
user_email: Email tied to the device.
167171
168172
extra_headers: Send extra headers
169173
@@ -246,9 +250,11 @@ async def create(
246250
timeout: float | httpx.Timeout | None | NotGiven = not_given,
247251
) -> Optional[CommandCreateResponse]:
248252
"""
249-
Initiate commands for up to 10 devices per account
253+
Initiate commands for up to 10 devices per account.
250254
251255
Args:
256+
account_id: Unique identifier linked to an account.
257+
252258
commands: List of device-level commands to execute
253259
254260
extra_headers: Send extra headers
@@ -298,21 +304,23 @@ def list(
298304
account, optionally filtered by time range, device, or other parameters
299305
300306
Args:
301-
page: Page number for pagination
307+
account_id: Unique identifier linked to an account.
308+
309+
page: Page number of paginated results.
302310
303-
per_page: Number of results per page
311+
per_page: Number of results per page.
304312
305-
command_type: Optionally filter executed commands by command type
313+
command_type: Optionally filter executed commands by command type.
306314
307-
device_id: Unique identifier for a device
315+
device_id: Unique identifier for a device.
308316
309-
from_: Start time for the query in ISO (RFC3339 - ISO 8601) format
317+
from_: Start time for the query in ISO (RFC3339 - ISO 8601) format.
310318
311-
status: Optionally filter executed commands by status
319+
status: Optionally filter executed commands by status.
312320
313-
to: End time for the query in ISO (RFC3339 - ISO 8601) format
321+
to: End time for the query in ISO (RFC3339 - ISO 8601) format.
314322
315-
user_email: Email tied to the device
323+
user_email: Email tied to the device.
316324
317325
extra_headers: Send extra headers
318326

src/cloudflare/resources/zero_trust/dex/commands/devices.py

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,13 @@ def list(
6363
connected in the last 1 hour.
6464
6565
Args:
66-
page: Page number of paginated results
66+
account_id: Unique identifier linked to an account.
6767
68-
per_page: Number of items per page
68+
page: Page number of paginated results.
6969
70-
search: Filter devices by name or email
70+
per_page: Number of results per page.
71+
72+
search: Filter devices by name or email.
7173
7274
extra_headers: Send extra headers
7375
@@ -139,11 +141,13 @@ def list(
139141
connected in the last 1 hour.
140142
141143
Args:
142-
page: Page number of paginated results
144+
account_id: Unique identifier linked to an account.
145+
146+
page: Page number of paginated results.
143147
144-
per_page: Number of items per page
148+
per_page: Number of results per page.
145149
146-
search: Filter devices by name or email
150+
search: Filter devices by name or email.
147151
148152
extra_headers: Send extra headers
149153

src/cloudflare/resources/zero_trust/dex/commands/downloads.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ def get(
6161
Bulk downloads are not supported
6262
6363
Args:
64+
account_id: Unique identifier linked to an account.
65+
6466
command_id: Unique identifier for a command
6567
6668
extra_headers: Send extra headers
@@ -130,6 +132,8 @@ async def get(
130132
Bulk downloads are not supported
131133
132134
Args:
135+
account_id: Unique identifier linked to an account.
136+
133137
command_id: Unique identifier for a command
134138
135139
extra_headers: Send extra headers

src/cloudflare/resources/zero_trust/dex/commands/quota.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ def get(
5959
specific account, including the time when the quota will reset
6060
6161
Args:
62+
account_id: Unique identifier linked to an account.
63+
6264
extra_headers: Send extra headers
6365
6466
extra_query: Add additional query parameters to the request
@@ -118,6 +120,8 @@ async def get(
118120
specific account, including the time when the quota will reset
119121
120122
Args:
123+
account_id: Unique identifier linked to an account.
124+
121125
extra_headers: Send extra headers
122126
123127
extra_query: Add additional query parameters to the request

0 commit comments

Comments
 (0)