chore: ROOT-88: Add activity logs endpoint to Label Studio SDK (#557)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Jo Booth <[email protected]>

Author: 3 people

.mock/definition/activityLog.yml .mock/definition/activityLogs.yml.mock/definition/activityLog.yml renamed to .mock/definition/activityLogs.yml

@@ -1,5 +1,5 @@
 types:
-  ApiActivityLogsListRequestMethod:
+  ActivityLogsListRequestMethod:
     enum:
       - DELETE
       - GET
@@ -16,7 +16,7 @@ service:
   auth: false
   base-path: ''
   endpoints:
-    api_activity_logs_list:
+    list:
       path: /api/activity-logs/
       method: GET
       auth: true
@@ -27,13 +27,13 @@ service:
         openapi: openapi/openapi.yaml
       display-name: Get activity logs
       request:
-        name: ApiActivityLogsListRequest
+        name: ActivityLogsListRequest
         query-parameters:
           end_date:
             type: optional<string>
             docs: End date/time (ISO-8601) for log filtering.
           method:
-            type: optional<ApiActivityLogsListRequestMethod>
+            type: optional<ActivityLogsListRequestMethod>
             default: all
             docs: HTTP request method used in the log.
           ordering:
@@ -80,5 +80,7 @@ service:
                     user_id: 1
                 recordsFiltered: 1
                 recordsTotal: 1
+      audiences:
+        - public
   source:
     openapi: openapi/openapi.yaml

.mock/openapi/openapi.yaml

@@ -85,7 +85,11 @@ paths:
         - Token: []
       summary: Get activity logs
       tags:
-        - Activity Log
+        - Activity Logs
+      x-fern-audiences:
+        - public
+      x-fern-sdk-group-name: activity_logs
+      x-fern-sdk-method-name: list
   /api/annotation-history/:
     delete:
       description: Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles.

poetry.lock

@@ -1,4 +1,145 @@
 # Reference
+## ActivityLogs
+<details><summary><code>client.activity_logs.<a href="src/label_studio_sdk/activity_logs/client.py">list</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve activity logs filtered by workspace, project, user, HTTP method, date range or search query.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from label_studio_sdk import LabelStudio
+
+client = LabelStudio(
+    api_key="YOUR_API_KEY",
+)
+client.activity_logs.list()
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**end_date:** `typing.Optional[str]` — End date/time (ISO-8601) for log filtering.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**method:** `typing.Optional[ActivityLogsListRequestMethod]` — HTTP request method used in the log.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**ordering:** `typing.Optional[str]` — Which field to use when ordering the results.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page:** `typing.Optional[int]` — [or "start"] Current page index.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**page_size:** `typing.Optional[int]` — [or "length"] Logs per page, use -1 to obtain all logs (might be slow).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**project:** `typing.Optional[int]` — Project ID to filter logs.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**search:** `typing.Optional[str]` — Search expression using "AND"/"OR" to filter by request URL.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**start_date:** `typing.Optional[str]` — Start date/time (ISO-8601) for log filtering.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**user:** `typing.Optional[int]` — User ID to filter logs.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**workspace:** `typing.Optional[int]` — Workspace owner ID to filter logs.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
 ## Annotations
 <details><summary><code>client.annotations.<a href="src/label_studio_sdk/annotations/client.py">create_bulk</a>(...)</code></summary>
 <dl>

reference.md

@@ -2,6 +2,8 @@
 
 from .types import (
     ActionsEnum,
+    ActivityLog,
+    ActivityLogResponse,
     AllRolesProjectList,
     AllRolesProjectListSampling,
     AllRolesProjectListSkipQueue,
@@ -200,6 +202,7 @@
 )
 from . import (
     actions,
+    activity_logs,
     annotations,
     billing,
     comments,
@@ -238,6 +241,7 @@
     ActionsListResponseItem,
     ActionsListResponseItemDialog,
 )
+from .activity_logs import ActivityLogsListRequestMethod
 from .annotations import AnnotationBulkSerializerWithSelectedItemsRequestLastAction, AnnotationsCreateBulkResponseItem
 from .client import AsyncLabelStudio, LabelStudio
 from .environment import LabelStudioEnvironment
@@ -310,6 +314,9 @@
     "ActionsEnum",
     "ActionsListResponseItem",
     "ActionsListResponseItemDialog",
+    "ActivityLog",
+    "ActivityLogResponse",
+    "ActivityLogsListRequestMethod",
     "AllRolesProjectList",
     "AllRolesProjectListSampling",
     "AllRolesProjectListSkipQueue",
@@ -560,6 +567,7 @@
     "WorkspaceMemberList",
     "__version__",
     "actions",
+    "activity_logs",
     "annotations",
     "billing",
     "comments",

src/label_studio_sdk/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import ActivityLogsListRequestMethod
+
+__all__ = ["ActivityLogsListRequestMethod"]