diff --git a/CHANGELOG.md b/CHANGELOG.md index cba9c58..76cc33e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,9 @@ ### Fixed - An issue where in some cases saved searches could not be retrieved. +### Deprecated +- Alert queries methods in the SDK, already deprecated, are more clearly marked. + ## 2.5.0 - 2025-06-06 ### Added diff --git a/docs/sdk/clients/alert_queries.md b/docs/sdk/clients/alert_queries.md index a6bdee7..664145e 100644 --- a/docs/sdk/clients/alert_queries.md +++ b/docs/sdk/clients/alert_queries.md @@ -1,4 +1,6 @@ -# Alert Querying +# Alert Querying (Deprecated) + +Alert queries are deprecated. Use [Sessions](sessions.md) instead. Use the `AlertQuery` class to create a query for searching and filtering Incydr alerts. More details on how to use the `AlertQuery` class can be found in the [Query Building](#query-building) section below. diff --git a/mkdocs.yml b/mkdocs.yml index 5bc4468..6dffd7c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,7 +45,6 @@ nav: - Actors: 'sdk/clients/actors.md' - Agents: 'sdk/clients/agents.md' - Alert Rules: 'sdk/clients/alert_rules.md' - - Alert Querying: 'sdk/clients/alert_queries.md' - Audit Log: 'sdk/clients/audit_log.md' - Cases: 'sdk/clients/cases.md' - Customer: 'sdk/clients/customer.md' @@ -61,6 +60,7 @@ nav: - Users: 'sdk/clients/users.md' - Watchlists: 'sdk/clients/watchlists.md' - Alerts (Deprecated): 'sdk/clients/alerts.md' + - Alert Querying (Deprecated): 'sdk/clients/alert_queries.md' - Devices (Deprecated): 'sdk/clients/devices.md' - Risk Profiles (Deprecated): 'sdk/clients/risk_profiles.md' - Enums: 'sdk/enums.md' diff --git a/src/_incydr_sdk/queries/alerts.py b/src/_incydr_sdk/queries/alerts.py index 103c8bc..fada3c6 100644 --- a/src/_incydr_sdk/queries/alerts.py +++ b/src/_incydr_sdk/queries/alerts.py @@ -4,6 +4,7 @@ from typing import List from typing import Optional from typing import Union +from warnings import warn from pydantic import BaseModel from pydantic import ConfigDict @@ -66,6 +67,8 @@ class FilterGroup(BaseModel): class AlertQuery(Model): """ + This class is deprecated. Use the Sessions client instead. + Class to build an alert query. Use the class methods to attach additional filter operators. Usage examples: @@ -110,6 +113,11 @@ def __init__( on: Union[date, datetime, int, float, str] = None, **kwargs, ): + warn( + "Alerts are deprecated. Replaced by Sessions.", + DeprecationWarning, + stacklevel=2, + ) groups = kwargs.get("groups") or [] if on and any((start_date, end_date)): raise ValueError(