-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.py
More file actions
1744 lines (1566 loc) · 58.2 KB
/
Copy pathapi.py
File metadata and controls
1744 lines (1566 loc) · 58.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""DatabunkerPro API Client"""
import json
import re
from datetime import datetime
from typing import Any, Dict, Iterable, List, Mapping, Optional, TypedDict, Union, cast
import requests
# Type definitions for better type safety and documentation
class UserOptions(TypedDict, total=False):
"""Options for user operations."""
groupname: Optional[Union[str, int]]
groupid: Optional[int]
rolename: Optional[Union[str, int]]
roleid: Optional[int]
slidingtime: Optional[str]
finaltime: Optional[str]
class LegalBasisOptions(TypedDict, total=False):
"""Options for legal basis operations."""
brief: str
status: Optional[str]
module: Optional[str]
fulldesc: Optional[str]
shortdesc: Optional[str]
basistype: Optional[str]
requiredmsg: Optional[str]
requiredflag: Optional[bool]
class LegalBasisUpdateOptions(TypedDict, total=False):
"""Options for legal basis update operations."""
status: Optional[str]
module: Optional[str]
fulldesc: Optional[str]
shortdesc: Optional[str]
basistype: Optional[str]
requiredmsg: Optional[str]
requiredflag: Optional[bool]
class AgreementAcceptOptions(TypedDict, total=False):
"""Options for agreement acceptance."""
agreementmethod: Optional[str]
referencecode: Optional[str]
starttime: Optional[str]
finaltime: Optional[str]
status: Optional[str]
lastmodifiedby: Optional[str]
class GroupOptions(TypedDict, total=False):
"""Options for group operations."""
groupname: str
grouptype: Optional[str]
groupdesc: Optional[str]
class RoleOptions(TypedDict, total=False):
"""Options for role operations."""
rolename: str
roledesc: Optional[str]
class TenantOptions(TypedDict, total=False):
"""Options for tenant operations."""
tenantname: str
tenantorg: str
email: str
class ProcessingActivityOptions(TypedDict, total=False):
"""Options for processing activity operations."""
activity: str
title: Optional[str]
script: Optional[str]
fulldesc: Optional[str]
applicableto: Optional[str]
class ProcessingActivityUpdateOptions(TypedDict, total=False):
"""Options for processing activity update operations."""
newactivity: Optional[str]
title: Optional[str]
script: Optional[str]
fulldesc: Optional[str]
applicableto: Optional[str]
class SharedRecordOptions(TypedDict, total=False):
"""Options for shared record operations."""
fields: Optional[
str
] # A string containing names of fields to share separated by commas
partner: Optional[
str
] # It is used as a reference to partner name. It is not enforced.
appname: Optional[
str
] # If defined, shows fields from the user app record instead of user profile
finaltime: Optional[str] # Expiration time for the shared record
class BasicOptions(TypedDict, total=False):
"""Basic options for operations."""
finaltime: Optional[str]
slidingtime: Optional[str]
class FileOptions(TypedDict, total=False):
"""Options for storing a file."""
mimetype: Optional[str]
tags: Optional[Union[List[str], str]]
finaltime: Optional[str]
slidingtime: Optional[str]
class TokenOptions(TypedDict, total=False):
"""Options for token operations."""
unique: Optional[bool]
slidingtime: Optional[str]
finaltime: Optional[str]
class PolicyOptions(TypedDict, total=False):
"""Options for policy operations."""
policyname: str
policydesc: Optional[str]
policy: Any
class PolicyUpdateOptions(TypedDict, total=False):
"""Options for policy update operations."""
policyname: Optional[str]
policydesc: Optional[str]
policy: Any
class PatchOperation(TypedDict, total=False):
"""Represents a patch operation for user data."""
op: str # Operation type (e.g., 'add', 'replace', 'remove')
path: str # JSON path to the field to modify
value: Optional[Any] # New value for the field
def _add_options(
data: Dict[str, Any], options: Optional[Mapping[str, Any]], keys: Iterable[str]
) -> Dict[str, Any]:
"""Copy the supplied `keys` from `options` into `data`, skipping unset ones.
An option the caller left out must stay out of the request body. Python's None
serializes to JSON null, and the server treats a null as a supplied value: it
validates `appname: null` and rejects it, and it panics on `requiredflag: null`.
Other language SDKs avoid this for free — JSON.stringify drops undefined — so
the guard has to be explicit here.
"""
for key in keys:
value = options.get(key) if options else None
if value is not None:
data[key] = value
return data
class DatabunkerproAPI:
"""Main client class for interacting with the DatabunkerPro API."""
def __init__(
self, base_url: str, x_bunker_token: str = "", x_bunker_tenant: str = ""
):
"""Initialize the DatabunkerPro API client."""
self.base_url = base_url.rstrip("/")
self.x_bunker_token = x_bunker_token
self.x_bunker_tenant = x_bunker_tenant
def _make_request(
self,
endpoint: str,
data: Optional[Dict[str, Any]] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Make a request to the DatabunkerPro API."""
headers = {"Content-Type": "application/json"}
if self.x_bunker_token:
headers["X-Bunker-Token"] = self.x_bunker_token
if self.x_bunker_tenant:
headers["X-Bunker-Tenant"] = self.x_bunker_tenant
url = f"{self.base_url}/v2/{endpoint}"
if data or request_metadata:
body_data = data.copy() if data else {}
if request_metadata:
body_data["request_metadata"] = request_metadata
body = json.dumps(body_data)
else:
body = None
try:
response = requests.post(url, headers=headers, data=body)
result: Dict[str, Any] = response.json()
if not response.ok:
if result.get("status"):
return result
else:
return {
"status": "error",
"message": result.get("message", "API request failed"),
}
return result
except requests.exceptions.RequestException as e:
return {"status": "error", "message": f"Error making request: {str(e)}"}
def raw_request(
self,
endpoint: str,
data: Optional[Dict[str, Any]] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> bytes:
"""Make a raw request to the DatabunkerPro API and return the response content."""
headers = {"Content-Type": "application/json"}
if self.x_bunker_token:
headers["X-Bunker-Token"] = self.x_bunker_token
if self.x_bunker_tenant:
headers["X-Bunker-Tenant"] = self.x_bunker_tenant
url = f"{self.base_url}/v2/{endpoint}"
if data or request_metadata:
body_data = data.copy() if data else {}
if request_metadata:
body_data["request_metadata"] = request_metadata
body = json.dumps(body_data)
else:
body = None
response = requests.post(url, headers=headers, data=body)
return response.content
# User Management
def create_user(
self,
profile: Dict[str, Any],
options: Optional[UserOptions] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Create a new user in DatabunkerPro."""
data: Dict[str, Any] = {"profile": profile}
if options:
# Handle groupname/groupid
if "groupname" in options and options["groupname"] is not None:
if str(options["groupname"]).isdigit():
data["groupid"] = int(options["groupname"])
else:
data["groupname"] = options["groupname"]
elif "groupid" in options and options["groupid"] is not None:
data["groupid"] = int(options["groupid"])
# Handle rolename/roleid
if "rolename" in options and options["rolename"] is not None:
if str(options["rolename"]).isdigit():
data["roleid"] = int(options["rolename"])
else:
data["rolename"] = options["rolename"]
elif "roleid" in options and options["roleid"] is not None:
data["roleid"] = int(options["roleid"])
# Handle time parameters
if "slidingtime" in options:
data["slidingtime"] = options["slidingtime"]
if "finaltime" in options:
data["finaltime"] = options["finaltime"]
return self._make_request("UserCreate", data, request_metadata)
def create_users_bulk(
self,
records: List[Dict[str, Any]],
options: Optional[BasicOptions] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""
Creates multiple users in bulk with their profiles and group information.
Args:
records: Array of user records to create
options: Global options for all users
request_metadata: Additional metadata to include with the request
Returns:
The created users information
Example:
# Create multiple users with global time settings
users = api.create_users_bulk([
{
"profile": {"email": "user1@example.com", "name": "User One"},
"groupname": "premium"
},
{
"profile": {"email": "user2@example.com", "name": "User Two"},
"groupid": 123
}
], {
"finaltime": "100d",
"slidingtime": "30d"
})
"""
data: Dict[str, Any] = {
"records": [
{
"profile": record["profile"],
**(
{"groupid": int(record["groupname"])}
if "groupname" in record
and record["groupname"] is not None
and str(record["groupname"]).isdigit()
else (
{"groupname": record["groupname"]}
if "groupname" in record and record["groupname"] is not None
else {}
)
),
**(
{"groupid": int(record["groupid"])}
if "groupid" in record and record["groupid"] is not None
else {}
),
**(
{"roleid": int(record["rolename"])}
if "rolename" in record
and record["rolename"] is not None
and str(record["rolename"]).isdigit()
else (
{"rolename": record["rolename"]}
if "rolename" in record and record["rolename"] is not None
else {}
)
),
**(
{"roleid": int(record["roleid"])}
if "roleid" in record and record["roleid"] is not None
else {}
),
}
for record in records
]
}
if options:
if "finaltime" in options:
data["finaltime"] = options["finaltime"]
if "slidingtime" in options:
data["slidingtime"] = options["slidingtime"]
return self._make_request("UserCreateBulk", data, request_metadata)
def get_user(
self,
mode: str,
identity: str,
version: Optional[int] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Get user information from DatabunkerPro."""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
}
if version is not None:
data["version"] = version
return self._make_request("UserGet", data, request_metadata)
def update_user(
self,
mode: str,
identity: str,
profile: Dict[str, Any],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Update user information in DatabunkerPro."""
data = {
"mode": mode,
"identity": identity,
"profile": profile,
}
return self._make_request("UserUpdate", data, request_metadata)
def request_user_update(
self,
mode: str,
identity: str,
profile: Dict[str, Any],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Request update of user information in DatabunkerPro."""
data = {
"mode": mode,
"identity": identity,
"profile": profile,
}
return self._make_request("UserUpdateRequest", data, request_metadata)
def patch_user(
self,
mode: str,
identity: str,
patch: List[PatchOperation],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Patch a user record with specific changes."""
data = {
"mode": mode,
"identity": identity,
"patch": patch,
}
return self._make_request("UserPatch", data, request_metadata)
def request_user_patch(
self,
mode: str,
identity: str,
patch: List[PatchOperation],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Request a user patch operation."""
data = {
"mode": mode,
"identity": identity,
"patch": patch,
}
return self._make_request("UserPatchRequest", data, request_metadata)
def delete_user(
self,
mode: str,
identity: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Delete a user from DatabunkerPro."""
data = {
"mode": mode,
"identity": identity,
}
return self._make_request("UserDelete", data, request_metadata)
def delete_users_bulk(
self,
users: List[Dict[str, str]],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""
Delete multiple users in bulk from DatabunkerPro.
Args:
users: List of user dictionaries containing mode and identity for each user to delete
request_metadata: Optional request metadata
Returns:
Dict containing the result of the bulk deletion operation
Example:
>>> users_to_delete = [
... {"mode": "email", "identity": "user1@example.com"},
... {"mode": "phone", "identity": "+1234567890"}
... ]
>>> result = api.delete_users_bulk(users_to_delete)
>>> print(result)
{'status': 'ok', 'deleted_count': 2}
"""
data = {"users": users}
return self._make_request("UserDeleteBulk", data, request_metadata)
def request_user_deletion(
self,
mode: str,
identity: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Request deletion of a user from DatabunkerPro."""
data = {
"mode": mode,
"identity": identity,
}
return self._make_request("UserDeleteRequest", data, request_metadata)
def search_user(
self,
identity: str,
unlock_uuid: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Search for a user with unlock UUID. Mode is auto-detected from identity."""
data = {
"identity": identity,
"unlockuuid": unlock_uuid,
}
return self._make_request("UserSearch", data, request_metadata)
def list_user_versions(
self,
mode: str,
identity: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""List all versions of a user record."""
data = {
"mode": mode,
"identity": identity,
}
return self._make_request("UserListVersions", data, request_metadata)
def create_user_x_token(
self,
mode: str,
identity: str,
options: Optional[BasicOptions] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Creates an access token for a user."""
data = {"mode": mode, "identity": identity}
if options:
data.update(cast(Dict[str, Any], options))
return self._make_request("XTokenCreateForUser", data, request_metadata)
def create_role_x_token(
self,
role_ref: Union[str, int],
options: Optional[BasicOptions] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Creates an access token for a role."""
data: Dict[str, Any] = {}
if options:
data.update(cast(Dict[str, Any], options))
if isinstance(role_ref, int) or str(role_ref).isdigit():
data["roleid"] = int(role_ref)
else:
data["rolename"] = str(role_ref)
return self._make_request("XTokenCreateForRole", data, request_metadata)
# User Request Management
def get_user_request(
self, request_uuid: str, request_metadata: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]:
"""Get a specific user request by UUID."""
data = {
"requestuuid": request_uuid,
}
return self._make_request("UserRequestGet", data, request_metadata)
def list_user_requests(
self,
mode: str,
identity: str,
offset: int = 0,
limit: int = 10,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""List user requests for a specific user."""
data = {
"mode": mode,
"identity": identity,
"offset": offset,
"limit": limit,
}
return self._make_request("UserRequestListUserRequests", data, request_metadata)
def cancel_user_request(
self,
request_uuid: str,
options: Optional[Dict[str, Any]] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Cancels a user request."""
data = {"requestuuid": request_uuid}
if options and "reason" in options:
data["reason"] = options["reason"]
return self._make_request("UserRequestCancel", data, request_metadata)
def approve_user_request(
self,
request_uuid: str,
options: Optional[Dict[str, Any]] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Approve a user request."""
data = {"requestuuid": request_uuid}
if options and "reason" in options:
data["reason"] = options["reason"]
return self._make_request("UserRequestApprove", data, request_metadata)
# App Data Management
def create_app_data(
self,
mode: str,
identity: str,
appname: str,
appdata: Dict[str, Any],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Create application data for a user."""
data = {
"mode": mode,
"identity": identity,
"appname": appname,
"appdata": appdata,
}
return self._make_request("AppdataCreate", data, request_metadata)
def get_app_data(
self,
mode: str,
identity: str,
appname: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Get application data for a user."""
data = {
"mode": mode,
"identity": identity,
"appname": appname,
}
return self._make_request("AppdataGet", data, request_metadata)
def update_app_data(
self,
mode: str,
identity: str,
appname: str,
appdata: Dict[str, Any],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Update application data for a user."""
data = {
"mode": mode,
"identity": identity,
"appname": appname,
"appdata": appdata,
}
return self._make_request("AppdataUpdate", data, request_metadata)
def request_app_data_update(
self,
mode: str,
identity: str,
appname: str,
appdata: Dict[str, Any],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Request update of application data for a user."""
data = {
"mode": mode,
"identity": identity,
"appname": appname,
"appdata": appdata,
}
return self._make_request("AppdataUpdateRequest", data, request_metadata)
def list_app_data_names(
self,
mode: str,
identity: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""List all application data records for a user."""
data = {
"mode": mode,
"identity": identity,
}
return self._make_request("AppdataListUserAppNames", data, request_metadata)
def list_app_names(
self, request_metadata: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]:
"""List all application names in the system."""
return self._make_request("AppdataListAppNames", None, request_metadata)
def list_app_data_versions(
self,
mode: str,
identity: str,
appname: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""List all versions of application data for a user."""
data = {
"mode": mode,
"identity": identity,
"appname": appname,
}
return self._make_request("AppdataListVersions", data, request_metadata)
def delete_app_data(
self,
mode: str,
identity: str,
appname: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Delete application data for a user."""
data = {
"mode": mode,
"identity": identity,
"appname": appname,
}
return self._make_request("AppdataDelete", data, request_metadata)
# File Storage
def create_file(
self,
mode: str,
identity: str,
filename: str,
filedata: str,
options: Optional[FileOptions] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Store an encrypted file for a user.
Args:
mode: User identification mode (login, token, email, phone, custom)
identity: User identifier corresponding to the mode
filename: Name of the file
filedata: File content, base64-encoded
options: Optional mimetype, tags, slidingtime, finaltime
request_metadata: Additional metadata to include with the request
Returns:
The stored file information, including its fileuuid
"""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
"filename": filename,
"filedata": filedata,
}
if options:
for key in ("mimetype", "tags", "slidingtime", "finaltime"):
if key in options:
data[key] = options[key]
return self._make_request("FileCreate", data, request_metadata)
def get_file(
self,
mode: str,
identity: str,
fileuuid: Optional[str] = None,
filename: Optional[str] = None,
raw: Optional[bool] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Get a user file, selected by fileuuid or filename.
At least one of fileuuid or filename is required. When selecting by
filename, the most recently created file with that name is returned.
"""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
}
if fileuuid is not None:
data["fileuuid"] = fileuuid
if filename is not None:
data["filename"] = filename
if raw is not None:
data["raw"] = raw
return self._make_request("FileGet", data, request_metadata)
def list_user_files(
self,
mode: str,
identity: str,
tag: Optional[str] = None,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""List the metadata of all files owned by a user.
Args:
mode: User identification mode (login, token, email, phone, custom)
identity: User identifier corresponding to the mode
tag: Optional. Return only files carrying this tag. A single tag
only — a comma-separated list is not split.
request_metadata: Additional metadata to include with the request
"""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
}
if tag is not None:
data["tag"] = tag
return self._make_request("FileListUserFiles", data, request_metadata)
def replace_file_tags(
self,
mode: str,
identity: str,
fileuuid: str,
tags: Union[List[str], str],
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Replace the complete tag set on a file.
The supplied list is authoritative — tags not included are removed.
Tags are lowercased and de-duplicated, must match
^[a-z0-9][a-z0-9._-]{0,49}$, and at most 16 are kept.
"""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
"fileuuid": fileuuid,
"tags": tags,
}
return self._make_request("FileReplaceTags", data, request_metadata)
def delete_file(
self,
mode: str,
identity: str,
fileuuid: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Delete a user file."""
data = {
"mode": mode,
"identity": identity,
"fileuuid": fileuuid,
}
return self._make_request("FileDelete", data, request_metadata)
# Legal Basis Management
def create_legal_basis(
self,
options: LegalBasisOptions,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Create a legal basis for data processing."""
data = _add_options(
{},
options,
(
"brief",
"status",
"module",
"fulldesc",
"shortdesc",
"basistype",
"requiredmsg",
"requiredflag",
),
)
return self._make_request("LegalBasisCreate", data, request_metadata)
def update_legal_basis(
self,
brief: str,
options: LegalBasisUpdateOptions,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Update an existing legal basis."""
data: Dict[str, Any] = {"brief": brief}
if options.get("status") is not None:
data["status"] = options["status"]
if options.get("module") is not None:
data["module"] = options["module"]
if options.get("fulldesc") is not None:
data["fulldesc"] = options["fulldesc"]
if options.get("shortdesc") is not None:
data["shortdesc"] = options["shortdesc"]
if options.get("basistype") is not None:
data["basistype"] = options["basistype"]
if options.get("requiredmsg") is not None:
data["requiredmsg"] = options["requiredmsg"]
if options.get("requiredflag") is not None:
data["requiredflag"] = options["requiredflag"]
return self._make_request("LegalBasisUpdate", data, request_metadata)
def delete_legal_basis(
self, brief: str, request_metadata: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]:
"""Delete a legal basis."""
data = {"brief": brief}
return self._make_request("LegalBasisDelete", data, request_metadata)
def list_agreements(
self, request_metadata: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]:
"""List all agreements."""
return self._make_request("LegalBasisListAgreements", None, request_metadata)
# Agreement Management
def accept_agreement(
self,
mode: str,
identity: str,
brief: str,
options: AgreementAcceptOptions,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Accept an agreement for a user."""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
"brief": brief,
}
if options.get("agreementmethod"):
data["agreementmethod"] = options["agreementmethod"]
if options.get("lastmodifiedby"):
data["lastmodifiedby"] = options["lastmodifiedby"]
if options.get("referencecode"):
data["referencecode"] = options["referencecode"]
if options.get("starttime"):
data["starttime"] = options["starttime"]
if options.get("finaltime"):
data["finaltime"] = options["finaltime"]
if options.get("status"):
data["status"] = options["status"]
return self._make_request("AgreementAccept", data, request_metadata)
def get_user_agreement(
self,
mode: str,
identity: str,
brief: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Get a specific agreement for a user."""
data: Dict[str, Any] = {
"mode": mode,
"identity": identity,
"brief": brief,
}
return self._make_request("AgreementGet", data, request_metadata)
def list_user_agreements(
self,
mode: str,
identity: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""List all agreements for a user."""
data = {
"mode": mode,
"identity": identity,
}
return self._make_request("AgreementListUserAgreements", data, request_metadata)
def cancel_agreement(
self,
mode: str,
identity: str,
brief: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Cancel an agreement for a user."""
data = {
"mode": mode,
"identity": identity,
"brief": brief,
}
return self._make_request("AgreementCancel", data, request_metadata)
def request_agreement_cancellation(
self,
mode: str,
identity: str,
brief: str,
request_metadata: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""Request cancellation of an agreement for a user."""
data = {
"mode": mode,
"identity": identity,
"brief": brief,
}
return self._make_request("AgreementCancelRequest", data, request_metadata)
def revoke_all_agreements(
self, brief: str, request_metadata: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]:
"""Revoke all agreements for a specific legal basis."""
data = {"brief": brief}
return self._make_request("AgreementRevokeAll", data, request_metadata)
# Processing Activity Management
def list_processing_activities(
self, request_metadata: Optional[Dict[str, Any]] = None
) -> Dict[str, Any]:
"""List all processing activities."""
return self._make_request(