docs: Document valid participant attributes

edgarrmondragon · Dec 5, 2023 · a623448 · a623448
1 parent e92d916
commit a623448
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -39,6 +39,8 @@ services:
       POSTGRES_PASSWORD: secret
     volumes:
       - "limedb:/var/lib/postgresql/data"
+    ports:
+      - 5432:5432
     healthcheck:
       test: ["CMD", "pg_isready", "-U", "limesurvey"]
       interval: 30s

diff --git a/src/citric/client.py b/src/citric/client.py
@@ -1326,7 +1326,7 @@ def list_participants(
         start: int = 0,
         limit: int = 10,
         unused: bool = False,
-        attributes: t.Sequence[str] | bool = False,
+        attributes: t.Sequence[types.ParticipantAttribute | str] | bool = False,
         conditions: t.Mapping[str, t.Any] | None = None,
     ) -> list[dict[str, t.Any]]:
         """Get participants in a survey.

diff --git a/src/citric/types.py b/src/citric/types.py
@@ -516,3 +516,23 @@ class SurveyUserActivationSettings(t.TypedDict, total=False):
     ipanonymize: bool
     refurl: bool
     savetimings: bool
+
+
+ParticipantAttribute = t.Literal[
+    "tid",
+    "partcipant_id",
+    "firstname",
+    "lastname",
+    "email",
+    "emailstatus",
+    "token",
+    "language",
+    "blacklisted",
+    "sent",
+    "remindersent",
+    "remindercount",
+    "completed",
+    "usesleft",
+    "validfrom",
+    "validuntil",
+]