Skip to content

Commit b6ca4bd

Browse files
stainless-app[bot]stainless-bot
stainless-app[bot]
authored and
stainless-bot
committed
feat(api): api update (#2149)
1 parent 178ca7e commit b6ca4bd

21 files changed

+104
-113
lines changed

‎.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 1417
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-238bdc2301e165198e92ece05a86c3b80aa6653c5cd7334b3dc59fd9d687acce.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-1c64fbec9a1e17ca560abf251c26a4adb4d60123dbe3f7dcc10819494cd97a6f.yml

‎src/cloudflare/resources/email_security/investigate.py

+38-42
Original file line numberDiff line numberDiff line change
@@ -79,29 +79,28 @@ def list(
7979
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
8080
) -> SyncV4PagePaginationArray[InvestigateListResponse]:
8181
"""
82-
This endpoint returns information for each email that matches the search
83-
parameter(s).
82+
Returns information for each email that matches the search parameter(s).
8483
8584
Args:
8685
account_id: Account Identifier
8786
88-
action_log: Controls whether the message action log in included in the response.
87+
action_log: Determines if the message action log is included in the response.
8988
90-
detections_only: If `false`, the search includes non-detections.
89+
detections_only: Determines if the search results will include detections or not.
9190
92-
domain: Filter by the sender domain
91+
domain: The sender domains the search filters by.
9392
9493
end: The end of the search date range. Defaults to `now`.
9594
96-
final_disposition: Filter messages by the provided disposition.
95+
final_disposition: The dispositions the search filters by.
9796
98-
message_action: Filter messages by actions applied to them
97+
message_action: The message actions the search filters by.
9998
100-
page: Page number of paginated results.
99+
page: The page number of paginated results.
101100
102-
per_page: Number of results to display.
101+
per_page: The number of results per page.
103102
104-
query: Space delimited query term(s). The search is case-insensitive.
103+
query: The space-delimited term used in the query. The search is case-insensitive.
105104
106105
The content of the following email metadata fields are searched:
107106
@@ -183,13 +182,13 @@ def detections(
183182
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
184183
) -> InvestigateDetectionsResponse:
185184
"""
186-
For emails that have a detection, this endpoint returns detection details such
187-
as threat categories, sender information, and links.
185+
Returns detection details such as threat categories and sender information for
186+
non-benign messages.
188187
189188
Args:
190189
account_id: Account Identifier
191190
192-
postfix_id: Message identifier
191+
postfix_id: The identifier of the message.
193192
194193
extra_headers: Send extra headers
195194
@@ -233,7 +232,7 @@ def get(
233232
Args:
234233
account_id: Account Identifier
235234
236-
postfix_id: Message identifier
235+
postfix_id: The identifier of the message.
237236
238237
extra_headers: Send extra headers
239238
@@ -272,13 +271,13 @@ def preview(
272271
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
273272
) -> InvestigatePreviewResponse:
274273
"""
275-
For emails that have a detection, this endpoint returns a preview of the message
276-
body as a base64 encoded PNG image.
274+
Returns a preview of the message body as a base64 encoded PNG image for
275+
non-benign messages.
277276
278277
Args:
279278
account_id: Account Identifier
280279
281-
postfix_id: Message identifier
280+
postfix_id: The identifier of the message.
282281
283282
extra_headers: Send extra headers
284283
@@ -317,13 +316,12 @@ def raw(
317316
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
318317
) -> InvestigateRawResponse:
319318
"""
320-
For emails that have a detection, this endpoint returns the raw email as an EML
321-
file.
319+
Returns the raw eml of any non-benign message.
322320
323321
Args:
324322
account_id: Account Identifier
325323
326-
postfix_id: Message identifier
324+
postfix_id: The identifier of the message.
327325
328326
extra_headers: Send extra headers
329327
@@ -367,7 +365,7 @@ def trace(
367365
Args:
368366
account_id: Account Identifier
369367
370-
postfix_id: Message identifier
368+
postfix_id: The identifier of the message.
371369
372370
extra_headers: Send extra headers
373371
@@ -441,29 +439,28 @@ def list(
441439
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
442440
) -> AsyncPaginator[InvestigateListResponse, AsyncV4PagePaginationArray[InvestigateListResponse]]:
443441
"""
444-
This endpoint returns information for each email that matches the search
445-
parameter(s).
442+
Returns information for each email that matches the search parameter(s).
446443
447444
Args:
448445
account_id: Account Identifier
449446
450-
action_log: Controls whether the message action log in included in the response.
447+
action_log: Determines if the message action log is included in the response.
451448
452-
detections_only: If `false`, the search includes non-detections.
449+
detections_only: Determines if the search results will include detections or not.
453450
454-
domain: Filter by the sender domain
451+
domain: The sender domains the search filters by.
455452
456453
end: The end of the search date range. Defaults to `now`.
457454
458-
final_disposition: Filter messages by the provided disposition.
455+
final_disposition: The dispositions the search filters by.
459456
460-
message_action: Filter messages by actions applied to them
457+
message_action: The message actions the search filters by.
461458
462-
page: Page number of paginated results.
459+
page: The page number of paginated results.
463460
464-
per_page: Number of results to display.
461+
per_page: The number of results per page.
465462
466-
query: Space delimited query term(s). The search is case-insensitive.
463+
query: The space-delimited term used in the query. The search is case-insensitive.
467464
468465
The content of the following email metadata fields are searched:
469466
@@ -545,13 +542,13 @@ async def detections(
545542
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
546543
) -> InvestigateDetectionsResponse:
547544
"""
548-
For emails that have a detection, this endpoint returns detection details such
549-
as threat categories, sender information, and links.
545+
Returns detection details such as threat categories and sender information for
546+
non-benign messages.
550547
551548
Args:
552549
account_id: Account Identifier
553550
554-
postfix_id: Message identifier
551+
postfix_id: The identifier of the message.
555552
556553
extra_headers: Send extra headers
557554
@@ -595,7 +592,7 @@ async def get(
595592
Args:
596593
account_id: Account Identifier
597594
598-
postfix_id: Message identifier
595+
postfix_id: The identifier of the message.
599596
600597
extra_headers: Send extra headers
601598
@@ -634,13 +631,13 @@ async def preview(
634631
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
635632
) -> InvestigatePreviewResponse:
636633
"""
637-
For emails that have a detection, this endpoint returns a preview of the message
638-
body as a base64 encoded PNG image.
634+
Returns a preview of the message body as a base64 encoded PNG image for
635+
non-benign messages.
639636
640637
Args:
641638
account_id: Account Identifier
642639
643-
postfix_id: Message identifier
640+
postfix_id: The identifier of the message.
644641
645642
extra_headers: Send extra headers
646643
@@ -679,13 +676,12 @@ async def raw(
679676
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
680677
) -> InvestigateRawResponse:
681678
"""
682-
For emails that have a detection, this endpoint returns the raw email as an EML
683-
file.
679+
Returns the raw eml of any non-benign message.
684680
685681
Args:
686682
account_id: Account Identifier
687683
688-
postfix_id: Message identifier
684+
postfix_id: The identifier of the message.
689685
690686
extra_headers: Send extra headers
691687
@@ -729,7 +725,7 @@ async def trace(
729725
Args:
730726
account_id: Account Identifier
731727
732-
postfix_id: Message identifier
728+
postfix_id: The identifier of the message.
733729
734730
extra_headers: Send extra headers
735731

‎src/cloudflare/resources/email_security/settings/allow_patterns.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ def list(
202202
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
203203
) -> SyncV4PagePaginationArray[AllowPatternListResponse]:
204204
"""
205-
List, search, and sort an accounts's email allow patterns.
205+
Lists, searches, and sorts an account’s email allow patterns.
206206
207207
Args:
208208
account_id: Account Identifier
@@ -211,9 +211,9 @@ def list(
211211
212212
order: The field to sort by.
213213
214-
page: Page number of paginated results.
214+
page: The page number of paginated results.
215215
216-
per_page: Number of results to display.
216+
per_page: The number of results per page.
217217
218218
search: Allows searching in multiple properties of a record simultaneously. This
219219
parameter is intended for human users, not automation. Its exact behavior is
@@ -562,7 +562,7 @@ def list(
562562
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
563563
) -> AsyncPaginator[AllowPatternListResponse, AsyncV4PagePaginationArray[AllowPatternListResponse]]:
564564
"""
565-
List, search, and sort an accounts's email allow patterns.
565+
Lists, searches, and sorts an account’s email allow patterns.
566566
567567
Args:
568568
account_id: Account Identifier
@@ -571,9 +571,9 @@ def list(
571571
572572
order: The field to sort by.
573573
574-
page: Page number of paginated results.
574+
page: The page number of paginated results.
575575
576-
per_page: Number of results to display.
576+
per_page: The number of results per page.
577577
578578
search: Allows searching in multiple properties of a record simultaneously. This
579579
parameter is intended for human users, not automation. Its exact behavior is

‎src/cloudflare/resources/email_security/settings/block_senders.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@ def list(
192192
193193
order: The field to sort by.
194194
195-
page: Page number of paginated results.
195+
page: The page number of paginated results.
196196
197-
per_page: Number of results to display.
197+
per_page: The number of results per page.
198198
199199
search: Allows searching in multiple properties of a record simultaneously. This
200200
parameter is intended for human users, not automation. Its exact behavior is
@@ -521,9 +521,9 @@ def list(
521521
522522
order: The field to sort by.
523523
524-
page: Page number of paginated results.
524+
page: The page number of paginated results.
525525
526-
per_page: Number of results to display.
526+
per_page: The number of results per page.
527527
528528
search: Allows searching in multiple properties of a record simultaneously. This
529529
parameter is intended for human users, not automation. Its exact behavior is

‎src/cloudflare/resources/email_security/settings/domains.py

+14-16
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,22 @@ def list(
7070
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
7171
) -> SyncV4PagePaginationArray[DomainListResponse]:
7272
"""
73-
List, search, and sort an account's email domains.
73+
Lists, searches, and sorts an account’s email domains.
7474
7575
Args:
7676
account_id: Account Identifier
7777
78-
allowed_delivery_mode: If present, the response contains only domains with the provided delivery mode.
78+
allowed_delivery_mode: Filters response to domains with the provided delivery mode.
7979
8080
direction: The sorting direction.
8181
82-
domain: Filter result by the provided domains. Allows for multiple occurrences, e.g.,
83-
`domain=example.com&domain=example.xyz`.
82+
domain: Filters results by the provided domains, allowing for multiple occurrences.
8483
8584
order: The field to sort by.
8685
87-
page: Page number of paginated results.
86+
page: The page number of paginated results.
8887
89-
per_page: Number of results to display.
88+
per_page: The number of results per page.
9089
9190
search: Allows searching in multiple properties of a record simultaneously. This
9291
parameter is intended for human users, not automation. Its exact behavior is
@@ -144,7 +143,7 @@ def delete(
144143
Args:
145144
account_id: Account Identifier
146145
147-
domain_id: Unique domain identifier
146+
domain_id: The unique identifier for the domain.
148147
149148
extra_headers: Send extra headers
150149
@@ -189,7 +188,7 @@ def edit(
189188
Args:
190189
account_id: Account Identifier
191190
192-
domain_id: Unique domain identifier
191+
domain_id: The unique identifier for the domain.
193192
194193
extra_headers: Send extra headers
195194
@@ -261,23 +260,22 @@ def list(
261260
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
262261
) -> AsyncPaginator[DomainListResponse, AsyncV4PagePaginationArray[DomainListResponse]]:
263262
"""
264-
List, search, and sort an account's email domains.
263+
Lists, searches, and sorts an account’s email domains.
265264
266265
Args:
267266
account_id: Account Identifier
268267
269-
allowed_delivery_mode: If present, the response contains only domains with the provided delivery mode.
268+
allowed_delivery_mode: Filters response to domains with the provided delivery mode.
270269
271270
direction: The sorting direction.
272271
273-
domain: Filter result by the provided domains. Allows for multiple occurrences, e.g.,
274-
`domain=example.com&domain=example.xyz`.
272+
domain: Filters results by the provided domains, allowing for multiple occurrences.
275273
276274
order: The field to sort by.
277275
278-
page: Page number of paginated results.
276+
page: The page number of paginated results.
279277
280-
per_page: Number of results to display.
278+
per_page: The number of results per page.
281279
282280
search: Allows searching in multiple properties of a record simultaneously. This
283281
parameter is intended for human users, not automation. Its exact behavior is
@@ -335,7 +333,7 @@ async def delete(
335333
Args:
336334
account_id: Account Identifier
337335
338-
domain_id: Unique domain identifier
336+
domain_id: The unique identifier for the domain.
339337
340338
extra_headers: Send extra headers
341339
@@ -380,7 +378,7 @@ async def edit(
380378
Args:
381379
account_id: Account Identifier
382380
383-
domain_id: Unique domain identifier
381+
domain_id: The unique identifier for the domain.
384382
385383
extra_headers: Send extra headers
386384

0 commit comments

Comments
 (0)