feat(threat_events): add list support

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 1712
+configured_endpoints: 1713
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-40991506ce58ce957e8a66e67a3ea0ce30eb6a573c30addc2a60a80ea6b378b8.yml
 openapi_spec_hash: 49aee83e2c8c51d02a2bf4c62d70b3c0
-config_hash: 92bfde5d1009bebb90da71119327e5bf
+config_hash: 747eb99c1820d67851071225b0065a26

api.md

@@ -8876,6 +8876,7 @@ Types:
 ```python
 from cloudflare.types.cloudforce_one import (
  ThreatEventCreateResponse,
+ ThreatEventListResponse,
  ThreatEventDeleteResponse,
  ThreatEventBulkCreateResponse,
  ThreatEventEditResponse,
@@ -8886,6 +8887,7 @@ from cloudflare.types.cloudforce_one import (
 Methods:
 
 - <code title="post /accounts/{account_id}/cloudforce-one/events/create">client.cloudforce_one.threat_events.<a href="./src/cloudflare/resources/cloudforce_one/threat_events/threat_events.py">create</a>(\*, path_account_id, \*\*<a href="src/cloudflare/types/cloudforce_one/threat_event_create_params.py">params</a>) -> <a href="./src/cloudflare/types/cloudforce_one/threat_event_create_response.py">ThreatEventCreateResponse</a></code>
+- <code title="get /accounts/{account_id}/cloudforce-one/events">client.cloudforce_one.threat_events.<a href="./src/cloudflare/resources/cloudforce_one/threat_events/threat_events.py">list</a>(\*, account_id, \*\*<a href="src/cloudflare/types/cloudforce_one/threat_event_list_params.py">params</a>) -> <a href="./src/cloudflare/types/cloudforce_one/threat_event_list_response.py">ThreatEventListResponse</a></code>
 - <code title="delete /accounts/{account_id}/cloudforce-one/events/{event_id}">client.cloudforce_one.threat_events.<a href="./src/cloudflare/resources/cloudforce_one/threat_events/threat_events.py">delete</a>(event_id, \*, account_id) -> <a href="./src/cloudflare/types/cloudforce_one/threat_event_delete_response.py">ThreatEventDeleteResponse</a></code>
 - <code title="post /accounts/{account_id}/cloudforce-one/events/create/bulk">client.cloudforce_one.threat_events.<a href="./src/cloudflare/resources/cloudforce_one/threat_events/threat_events.py">bulk_create</a>(\*, account_id, \*\*<a href="src/cloudflare/types/cloudforce_one/threat_event_bulk_create_params.py">params</a>) -> <a href="./src/cloudflare/types/cloudforce_one/threat_event_bulk_create_response.py">ThreatEventBulkCreateResponse</a></code>
 - <code title="patch /accounts/{account_id}/cloudforce-one/events/{event_id}">client.cloudforce_one.threat_events.<a href="./src/cloudflare/resources/cloudforce_one/threat_events/threat_events.py">edit</a>(event_id, \*, account_id, \*\*<a href="src/cloudflare/types/cloudforce_one/threat_event_edit_params.py">params</a>) -> <a href="./src/cloudflare/types/cloudforce_one/threat_event_edit_response.py">ThreatEventEditResponse</a></code>

src/cloudflare/resources/cloudforce_one/threat_events/threat_events.py

@@ -4,6 +4,7 @@
 
 from typing import List, Union, Iterable
 from datetime import datetime
+from typing_extensions import Literal
 
 import httpx
 
@@ -116,11 +117,13 @@
 )
 from ....types.cloudforce_one import (
  threat_event_edit_params,
+ threat_event_list_params,
  threat_event_create_params,
  threat_event_bulk_create_params,
 )
 from ....types.cloudforce_one.threat_event_get_response import ThreatEventGetResponse
 from ....types.cloudforce_one.threat_event_edit_response import ThreatEventEditResponse
+from ....types.cloudforce_one.threat_event_list_response import ThreatEventListResponse
 from ....types.cloudforce_one.threat_event_create_response import ThreatEventCreateResponse
 from ....types.cloudforce_one.threat_event_delete_response import ThreatEventDeleteResponse
 from ....types.cloudforce_one.threat_event_bulk_create_response import ThreatEventBulkCreateResponse
@@ -265,6 +268,63 @@ def create(
  cast_to=ThreatEventCreateResponse,
  )
 
+ def list(
+ self,
+ *,
+ account_id: float,
+ dataset_id: List[str] | NotGiven = NOT_GIVEN,
+ order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
+ order_by: str | NotGiven = NOT_GIVEN,
+ page: float | NotGiven = NOT_GIVEN,
+ page_size: float | NotGiven = NOT_GIVEN,
+ search: Iterable[threat_event_list_params.Search] | NotGiven = NOT_GIVEN,
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+ # The extra values given here take precedence over values defined on the client or passed to this method.
+ extra_headers: Headers | None = None,
+ extra_query: Query | None = None,
+ extra_body: Body | None = None,
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+ ) -> ThreatEventListResponse:
+ """The `datasetId` parameter must be defined.
+
+ Must provide query parameters. To
+ list existing datasets (and their IDs), use the
+ [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/)
+ endpoint.
+
+ Args:
+ account_id: Account ID
+
+ extra_headers: Send extra headers
+
+ extra_query: Add additional query parameters to the request
+
+ extra_body: Add additional JSON properties to the request
+
+ timeout: Override the client-level default timeout for this request, in seconds
+ """
+ return self._get(
+ f"/accounts/{account_id}/cloudforce-one/events",
+ options=make_request_options(
+ extra_headers=extra_headers,
+ extra_query=extra_query,
+ extra_body=extra_body,
+ timeout=timeout,
+ query=maybe_transform(
+ {
+ "dataset_id": dataset_id,
+ "order": order,
+ "order_by": order_by,
+ "page": page,
+ "page_size": page_size,
+ "search": search,
+ },
+ threat_event_list_params.ThreatEventListParams,
+ ),
+ ),
+ cast_to=ThreatEventListResponse,
+ )
+
  def delete(
  self,
  event_id: str,
@@ -592,6 +652,63 @@ async def create(
  cast_to=ThreatEventCreateResponse,
  )
 
+ async def list(
+ self,
+ *,
+ account_id: float,
+ dataset_id: List[str] | NotGiven = NOT_GIVEN,
+ order: Literal["asc", "desc"] | NotGiven = NOT_GIVEN,
+ order_by: str | NotGiven = NOT_GIVEN,
+ page: float | NotGiven = NOT_GIVEN,
+ page_size: float | NotGiven = NOT_GIVEN,
+ search: Iterable[threat_event_list_params.Search] | NotGiven = NOT_GIVEN,
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+ # The extra values given here take precedence over values defined on the client or passed to this method.
+ extra_headers: Headers | None = None,
+ extra_query: Query | None = None,
+ extra_body: Body | None = None,
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+ ) -> ThreatEventListResponse:
+ """The `datasetId` parameter must be defined.
+
+ Must provide query parameters. To
+ list existing datasets (and their IDs), use the
+ [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/)
+ endpoint.
+
+ Args:
+ account_id: Account ID
+
+ extra_headers: Send extra headers
+
+ extra_query: Add additional query parameters to the request
+
+ extra_body: Add additional JSON properties to the request
+
+ timeout: Override the client-level default timeout for this request, in seconds
+ """
+ return await self._get(
+ f"/accounts/{account_id}/cloudforce-one/events",
+ options=make_request_options(
+ extra_headers=extra_headers,
+ extra_query=extra_query,
+ extra_body=extra_body,
+ timeout=timeout,
+ query=await async_maybe_transform(
+ {
+ "dataset_id": dataset_id,
+ "order": order,
+ "order_by": order_by,
+ "page": page,
+ "page_size": page_size,
+ "search": search,
+ },
+ threat_event_list_params.ThreatEventListParams,
+ ),
+ ),
+ cast_to=ThreatEventListResponse,
+ )
+
  async def delete(
  self,
  event_id: str,
@@ -789,6 +906,9 @@ def __init__(self, threat_events: ThreatEventsResource) -> None:
  self.create = to_raw_response_wrapper(
  threat_events.create,
  )
+ self.list = to_raw_response_wrapper(
+ threat_events.list,
+ )
  self.delete = to_raw_response_wrapper(
  threat_events.delete,
  )
@@ -858,6 +978,9 @@ def __init__(self, threat_events: AsyncThreatEventsResource) -> None:
  self.create = async_to_raw_response_wrapper(
  threat_events.create,
  )
+ self.list = async_to_raw_response_wrapper(
+ threat_events.list,
+ )
  self.delete = async_to_raw_response_wrapper(
  threat_events.delete,
  )
@@ -927,6 +1050,9 @@ def __init__(self, threat_events: ThreatEventsResource) -> None:
  self.create = to_streamed_response_wrapper(
  threat_events.create,
  )
+ self.list = to_streamed_response_wrapper(
+ threat_events.list,
+ )
  self.delete = to_streamed_response_wrapper(
  threat_events.delete,
  )
@@ -996,6 +1122,9 @@ def __init__(self, threat_events: AsyncThreatEventsResource) -> None:
  self.create = async_to_streamed_response_wrapper(
  threat_events.create,
  )
+ self.list = async_to_streamed_response_wrapper(
+ threat_events.list,
+ )
  self.delete = async_to_streamed_response_wrapper(
  threat_events.delete,
  )

src/cloudflare/types/cloudforce_one/__init__.py

@@ -13,9 +13,11 @@
 from .request_types_response import RequestTypesResponse as RequestTypesResponse
 from .request_delete_response import RequestDeleteResponse as RequestDeleteResponse
 from .threat_event_edit_params import ThreatEventEditParams as ThreatEventEditParams
+from .threat_event_list_params import ThreatEventListParams as ThreatEventListParams
 from .threat_event_get_response import ThreatEventGetResponse as ThreatEventGetResponse
 from .threat_event_create_params import ThreatEventCreateParams as ThreatEventCreateParams
 from .threat_event_edit_response import ThreatEventEditResponse as ThreatEventEditResponse
+from .threat_event_list_response import ThreatEventListResponse as ThreatEventListResponse
 from .threat_event_create_response import ThreatEventCreateResponse as ThreatEventCreateResponse
 from .threat_event_delete_response import ThreatEventDeleteResponse as ThreatEventDeleteResponse
 from .threat_event_bulk_create_params import ThreatEventBulkCreateParams as ThreatEventBulkCreateParams

src/cloudflare/types/cloudforce_one/threat_event_list_params.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union, Iterable
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ThreatEventListParams", "Search"]
+
+
+class ThreatEventListParams(TypedDict, total=False):
+ account_id: Required[float]
+ """Account ID"""
+
+ dataset_id: Annotated[List[str], PropertyInfo(alias="datasetId")]
+
+ order: Literal["asc", "desc"]
+
+ order_by: Annotated[str, PropertyInfo(alias="orderBy")]
+
+ page: float
+
+ page_size: Annotated[float, PropertyInfo(alias="pageSize")]
+
+ search: Iterable[Search]
+
+
+class Search(TypedDict, total=False):
+ field: str
+
+ op: Literal["equals", "not", "gt", "gte", "lt", "lte", "like", "contains", "startsWith", "endsWith", "in", "find"]
+
+ value: Union[str, float, List[Union[str, float]]]

src/cloudflare/types/cloudforce_one/threat_event_list_response.py

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ThreatEventListResponse", "ThreatEventListResponseItem"]
+
+
+class ThreatEventListResponseItem(BaseModel):
+ id: float
+
+ account_id: float = FieldInfo(alias="accountId")
+
+ attacker: str
+
+ attacker_country: str = FieldInfo(alias="attackerCountry")
+
+ category: str
+
+ category_id: float = FieldInfo(alias="categoryId")
+
+ date: str
+
+ event: str
+
+ indicator: str
+
+ indicator_type: str = FieldInfo(alias="indicatorType")
+
+ indicator_type_id: float = FieldInfo(alias="indicatorTypeId")
+
+ kill_chain: float = FieldInfo(alias="killChain")
+
+ mitre_attack: List[str] = FieldInfo(alias="mitreAttack")
+
+ num_referenced: float = FieldInfo(alias="numReferenced")
+
+ num_references: float = FieldInfo(alias="numReferences")
+
+ raw_id: str = FieldInfo(alias="rawId")
+
+ referenced: List[str]
+
+ referenced_ids: List[float] = FieldInfo(alias="referencedIds")
+
+ references: List[str]
+
+ references_ids: List[float] = FieldInfo(alias="referencesIds")
+
+ tags: List[str]
+
+ target_country: str = FieldInfo(alias="targetCountry")
+
+ target_industry: str = FieldInfo(alias="targetIndustry")
+
+ tlp: str
+
+ uuid: str
+
+ insight: Optional[str] = None
+
+ releasability_id: Optional[str] = FieldInfo(alias="releasabilityId", default=None)
+
+
+ThreatEventListResponse: TypeAlias = List[ThreatEventListResponseItem]