deprecate devices, docs

Author: ceciliastevens

docs/cli/index.md

@@ -28,15 +28,18 @@ The following subcommand groups are available under the `incydr` command:
 * [Actors](cmds/actors.md)
 * [Agents](cmds/agents.md)
 * [Alert Rules](cmds/alert_rules.md)
-* [Alerts (Deprecated)](cmds/alerts.md)
 * [Audit Log](cmds/audit_log.md)
 * [Cases](cmds/cases.md)
 * [Departments](cmds/departments.md)
-* [Devices](cmds/devices.md)
 * [Directory Groups](cmds/directory_groups.md)
 * [File Events](cmds/file_events.md)
-* [Risk Profiles](cmds/risk_profiles.md)
 * [Sessions](cmds/sessions.md)
 * [Trusted Activities](cmds/trusted_activities.md)
 * [Users](cmds/users.md)
 * [Watchlists](cmds/watchlists.md)
+
+Deprecated command groups:
+
+* [Alerts (Deprecated)](cmds/alerts.md)
+* [Devices (Deprecated)](cmds/devices.md)
+* [Risk Profiles (Deprecated)](cmds/risk_profiles.md)

docs/sdk/clients/devices.md

@@ -1,4 +1,4 @@
-# Devices
+# Devices (Deprecated)
 
 ::: _incydr_sdk.devices.client.DevicesV1
     :docstring:

docs/sdk/clients/risk_profiles.md

@@ -1,4 +1,4 @@
-# Risk Profiles
+# Risk Profiles (Deprecated)
 
 ::: _incydr_sdk.risk_profiles.client.RiskProfilesV1
     :docstring:

docs/sdk/enums.md

@@ -124,7 +124,9 @@ Alerts has been replaced by [Sessions](#sessions).
 * **CLOSED**: `"CLOSED"`
 * **OPEN**: `"OPEN"`
 
-## Devices
+## Devices (Deprecated)
+
+Devices has been replaced by [Agents](#agents)
 
 ### Devices Sort Keys
 

docs/sdk/models.md

@@ -124,7 +124,10 @@ Alerts has been replaced by [Sessions](#sessions).
 ::: incydr.models.DepartmentsPage
     :docstring:
 
-## Devices
+## Devices (Deprecated)
+
+Devices has been replaced by [Agents](#agents).
+
 ---
 
 ### `Device` model
@@ -220,7 +223,10 @@ Alerts has been replaced by [Sessions](#sessions).
 :::incydr.models.Role
     :docstring:
 
-## Risk Profiles
+## Risk Profiles (Deprecated)
+
+Risk Profiles have been replaced by [Actors](#actors).
+
 ---
 
 ### `RiskProfile` model

mkdocs.yml

@@ -43,22 +43,22 @@ nav:
     - Reference:
       - Actors: 'sdk/clients/actors.md'
       - Agents: 'sdk/clients/agents.md'
-      - Alerts (Deprecated): 'sdk/clients/alerts.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'
       - Departments: 'sdk/clients/departments.md'
-      - Devices: 'sdk/clients/devices.md'
       - Directory Groups: 'sdk/clients/directory_groups.md'
       - File Events: 'sdk/clients/file_events.md'
       - File Event Querying: 'sdk/clients/file_event_queries.md'
-      - Risk Profiles: 'sdk/clients/risk_profiles.md'
       - Sessions: 'sdk/clients/sessions.md'
       - Trusted Activites: 'sdk/clients/trusted_activities.md'
       - Users: 'sdk/clients/users.md'
       - Watchlists: 'sdk/clients/watchlists.md'
+      - Alerts (Deprecated): 'sdk/clients/alerts.md'
+      - Devices (Deprecated): 'sdk/clients/devices.md'
+      - Risk Profiles (Deprecated): 'sdk/clients/risk_profiles.md'
     - Enums: 'sdk/enums.md'
     - Models: 'sdk/models.md'
   - CLI:
@@ -71,19 +71,19 @@ nav:
       - Commands:
         - Actors: 'cli/cmds/actors.md'
         - Agents: 'cli/cmds/agents.md'
-        - Alerts (Deprecated): 'cli/cmds/alerts.md'
         - Alert Rules: 'cli/cmds/alert_rules.md'
         - Audit Log: 'cli/cmds/audit_log.md'
         - Cases: 'cli/cmds/cases.md'
         - Departments: 'cli/cmds/departments.md'
-        - Devices: 'cli/cmds/devices.md'
         - Directory Groups: 'cli/cmds/directory_groups.md'
         - File Events: 'cli/cmds/file_events.md'
-        - Risk Profiles: 'cli/cmds/risk_profiles.md'
         - Sessions: 'cli/cmds/sessions.md'
         - Trusted Activites: 'cli/cmds/trusted_activities.md'
         - Users: 'cli/cmds/users.md'
         - Watchlists: 'cli/cmds/watchlists.md'
+        - Alerts (Deprecated): 'cli/cmds/alerts.md'
+        - Devices (Deprecated): 'cli/cmds/devices.md'
+        - Risk Profiles (Deprecated): 'cli/cmds/risk_profiles.md'
   - Guides:
       - Introduction: 'integration-guides/index.md'
       - Microsoft Sentinel:

src/_incydr_cli/cmds/alerts.py

@@ -47,7 +47,7 @@
 @click.group(cls=IncydrGroup)
 @logging_options
 def alerts():
-    """View and manage alerts."""
+    """DEPRECATED. Use the Sessions command group instead. View and manage alerts."""
     deprecation_warning(DEPRECATION_TEXT)
 
 

src/_incydr_cli/cmds/devices.py

@@ -9,17 +9,23 @@
 from _incydr_cli.cmds.options.output_options import SingleFormat
 from _incydr_cli.cmds.options.output_options import table_format_option
 from _incydr_cli.cmds.options.output_options import TableFormat
+from _incydr_cli.cmds.utils import deprecation_warning
 from _incydr_cli.core import IncydrCommand
 from _incydr_cli.core import IncydrGroup
 from _incydr_sdk.core.client import Client
 from _incydr_sdk.devices.models import Device
 from _incydr_sdk.utils import model_as_card
 
 
+# Deprecated 2025-03
+DEPRECATION_TEXT = "DeprecationWarning: Devices commands are deprecated. Use the 'incydr agents' command group instead."
+
+
 @click.group(cls=IncydrGroup)
 @logging_options
 def devices():
-    """View devices."""
+    """DEPRECATED. Use the agents command group instead. View devices."""
+    deprecation_warning(DEPRECATION_TEXT)
 
 
 @devices.command("list", cls=IncydrCommand)

src/_incydr_cli/cmds/risk_profiles.py

@@ -29,7 +29,7 @@
 @click.group(cls=IncydrGroup)
 @logging_options
 def risk_profiles():
-    """View and manage risk profiles."""
+    """DEPRECATED. Use the Actors command group instead. View and manage risk profiles."""
     deprecation_warning(DEPRECATION_TEXT)
 
 

src/_incydr_sdk/devices/client.py

@@ -1,5 +1,6 @@
 from itertools import count
 from typing import Iterator
+from warnings import warn
 
 from .models import Device
 from .models import DevicesPage
@@ -23,6 +24,8 @@ def v1(self):
 class DevicesV1:
     """Client for `/v1/devices` endpoints.
 
+    This client is deprecated. Use the Agents client instead.
+
     Usage example:
 
         >>> import incydr
@@ -43,6 +46,11 @@ def get_device(self, device_id: str) -> Device:
         **Returns**: A [`Device`][device-model] object representing the device.
 
         """
+        warn(
+            "Devices endpoints are deprecated. Replaced by Agents.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         response = self._parent.session.get(f"/v1/devices/{device_id}")
         return Device.parse_response(response)
 
@@ -71,6 +79,11 @@ def get_page(
 
         **Returns**: A ['DevicesPage'][devicespage-model] object.
         """
+        warn(
+            "Devices endpoints are deprecated. Replaced by Agents.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         page_size = page_size or self._parent.settings.page_size
         data = QueryDevicesRequest(
             page=page_num,
@@ -98,6 +111,11 @@ def iter_all(
 
         **Returns**: A generator yielding individual [`Device`][device-model] objects.
         """
+        warn(
+            "Devices endpoints are deprecated. Replaced by Agents.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         page_size = page_size or self._parent.settings.page_size
         for page_num in count(1):
             page = self.get_page(