remove detectionlists, high-risk-employee, and departing-employee cli… (

#458) * remove detectionlists, high-risk-employee, and departing-employee clients * remove references from docs * update names; remove detectionlists reference from user guide
code42 · Aug 9, 2023 · 027aa20 · 027aa20
1 parent a2ddc6a
commit 027aa20
Show file tree

Hide file tree

Showing 28 changed files with 73 additions and 2,425 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 The intended audience of this file is for py42 consumers -- as such, changes that don't affect
 how a consumer would use the library (e.g. adding unit tests, updating documentation, etc) are not captured here.
 
+## 1.27.0 - 2023-08-04
+
+### Removed
+
+- Removed the `detectionlists` client, which included `high_risk_employee` and `departing_employee` clients.
+- APIs had been deprecated and were replaced by the `Watchlists` client.  APIs are no longer available regardless of Py42 version.
+
 ## 1.26.2 - 2023-05-16
 
 ### Changed

diff --git a/docs/guides.md b/docs/guides.md
@@ -10,8 +10,6 @@
     Getting Started <userguides/gettingstarted>
     Basics <userguides/basics>
     userguides/searches
-    userguides/departingemployee
-    userguides/highriskemployee
     userguides/orgdevices
     Device Settings <userguides/devicesettings>
     Org Settings <userguides/orgsettings>
@@ -26,8 +24,6 @@
 * [Getting Started](userguides/gettingstarted.md)
 * [Basics](userguides/basics.md)
 * [Executing Searches](userguides/searches.md)
-* [Departing Employee](userguides/departingemployee.md)
-* [High Risk Employee](userguides/highriskemployee.md)
 * [Get Active Devices From An Organization](userguides/orgdevices.md)
 * [Device Settings](userguides/devicesettings.md)
 * [Org Settings](userguides/orgsettings.md)

diff --git a/docs/methoddocs/constants.md b/docs/methoddocs/constants.md
@@ -12,30 +12,12 @@
     :show-inheritance:
 ```
 
-```{eval-rst}
-.. autoclass:: py42.constants.RiskTags
-    :members:
-    :show-inheritance:
-```
-
 ```{eval-rst}
 .. autoclass:: py42.constants.TrustedActivityType
     :members:
     :show-inheritance:
 ```
 
-```{eval-rst}
-.. autoclass:: py42.constants.DepartingEmployeeFilters
-    :members:
-    :show-inheritance:
-```
-
-```{eval-rst}
-.. autoclass:: py42.constants.HighRiskEmployeeFilters
-    :members:
-    :show-inheritance:
-```
-
 ```{eval-rst}
 .. autoclass:: py42.constants.WatchlistType
     :members:

diff --git a/docs/methoddocs/detectionlists.md b/docs/methoddocs/detectionlists.md
diff --git a/docs/methods.md b/docs/methods.md
@@ -34,7 +34,6 @@ Explore the complete public documentation for `py42` below.
 * [Backup Sets](methoddocs/backupset.md)
 * [Cases](methoddocs/cases.md)
 * [Constants](methoddocs/constants.md)
-* [Detection Lists](methoddocs/detectionlists.md)
 * [Devices](methoddocs/devices.md)
 * [Device Settings](methoddocs/devicesettings.md)
 * [Exceptions](methoddocs/exceptions.md)

diff --git a/docs/userguides/basics.md b/docs/userguides/basics.md
@@ -69,15 +69,15 @@ returned by the generator gives you access to the actual list of items. Use the
 for working with generators and paging in py42:
 
 ```python
-# Prints the username and notes for all departing employees
+# Prints the username and user ID for all employees included on a watchlist
 
-pages = sdk.detectionlists.departing_employee.get_all()  # pages has 'generator' type
+pages = sdk.watchlists.get_all_included_users(WATCHLIST_ID)  # pages has 'generator' type
 for page in pages:  # page has 'Py42Response' type
-    employees = page["items"]
-    for employee in employees:
-        username = employee["userName"]
-        notes = employee["notes"]
-        print(f"{employee}: {notes}")
+    users = page["includedUsers"]
+    for user in users:
+        username = user["username"]
+        user_id = user["userId"]
+        print(f"{username}: {user_id}")
 ```
 
 Each page is a typical py42 response. The next section covers what you can do with `Py42Response` objects.

diff --git a/docs/userguides/departingemployee.md b/docs/userguides/departingemployee.md
diff --git a/docs/userguides/highriskemployee.md b/docs/userguides/highriskemployee.md
diff --git a/src/py42/__version__.py b/src/py42/__version__.py
@@ -1,3 +1,3 @@
 # py42
 
-__version__ = "1.26.2"
+__version__ = "1.27.0"
diff --git a/src/py42/clients/__init__.py b/src/py42/clients/__init__.py
@@ -6,7 +6,6 @@
         "alerts",
         "archive",
         "authority",
-        "detectionlists",
         "securitydata",
         "auditlogs",
         "cases",