nextcloud-client 0.211.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,239 @@
1
+ from typing import Dict, List, Optional
2
+
3
+ from .base import BaseNextcloudClient
4
+ from .models.users import UserDetails
5
+ from .ocs import OCS_REQUEST_HEADERS
6
+
7
+
8
+ class UsersClient(BaseNextcloudClient):
9
+ """Client for Nextcloud User API operations."""
10
+
11
+ app_name = "users"
12
+
13
+ def _get_user_headers(
14
+ self, additional_headers: Optional[Dict[str, str]] = None
15
+ ) -> Dict[str, str]:
16
+ """Get standard headers required for User API calls."""
17
+ headers = dict(OCS_REQUEST_HEADERS)
18
+ if additional_headers:
19
+ headers.update(additional_headers)
20
+ return headers
21
+
22
+ async def create_user(
23
+ self,
24
+ userid: str,
25
+ password: Optional[str] = None,
26
+ display_name: Optional[str] = None,
27
+ email: Optional[str] = None,
28
+ groups: Optional[List[str]] = None,
29
+ subadmin_groups: Optional[List[str]] = None,
30
+ quota: Optional[str] = None,
31
+ language: Optional[str] = None,
32
+ ) -> None:
33
+ """
34
+ Create a new user on the Nextcloud server.
35
+ """
36
+ data = {"userid": userid}
37
+ if password is not None:
38
+ data["password"] = password
39
+ if display_name is not None:
40
+ data["displayName"] = display_name
41
+ if email is not None:
42
+ data["email"] = email
43
+ if groups is not None:
44
+ for i, group in enumerate(groups):
45
+ data[f"groups[{i}]"] = group
46
+ if subadmin_groups is not None:
47
+ for i, group in enumerate(subadmin_groups):
48
+ data[f"subadmin[{i}]"] = group
49
+ if quota is not None:
50
+ data["quota"] = quota
51
+ if language is not None:
52
+ data["language"] = language
53
+
54
+ headers = self._get_user_headers()
55
+ await self._make_request(
56
+ "POST", "/ocs/v2.php/cloud/users", data=data, headers=headers
57
+ )
58
+
59
+ async def search_users(
60
+ self,
61
+ search: Optional[str] = None,
62
+ limit: Optional[int] = None,
63
+ offset: Optional[int] = None,
64
+ ) -> List[str]:
65
+ """
66
+ Retrieves a list of users from the Nextcloud server.
67
+ """
68
+ params = {}
69
+ if search is not None:
70
+ params["search"] = search
71
+ if limit is not None:
72
+ params["limit"] = limit
73
+ if offset is not None:
74
+ params["offset"] = offset
75
+
76
+ headers = self._get_user_headers()
77
+ response = await self._make_request(
78
+ "GET", "/ocs/v2.php/cloud/users", params=params, headers=headers
79
+ )
80
+ # The v2 API returns JSON with users as a direct list under data.users
81
+ data = response.json()["ocs"]["data"]
82
+ return data.get("users", [])
83
+
84
+ async def get_user_details(self, userid: str) -> UserDetails:
85
+ """
86
+ Retrieves information about a single user.
87
+ """
88
+ headers = self._get_user_headers()
89
+ response = await self._make_request(
90
+ "GET", f"/ocs/v2.php/cloud/users/{userid}", headers=headers
91
+ )
92
+ return UserDetails(**response.json()["ocs"]["data"])
93
+
94
+ async def get_current_user_timezone(self) -> str:
95
+ """The authenticated user's ``core/timezone`` preference, or ``""``.
96
+
97
+ OCS ``/cloud/user`` is the only way to read it: the provisioning
98
+ preferences API registers POST/DELETE but no GET. Querying the current
99
+ user (not ``/cloud/users/{id}``) also sidesteps loginName != UID.
100
+ """
101
+ headers = self._get_user_headers()
102
+ response = await self._make_request(
103
+ "GET", "/ocs/v2.php/cloud/user", headers=headers
104
+ )
105
+ return response.json()["ocs"]["data"].get("timezone") or ""
106
+
107
+ async def update_user_field(self, userid: str, key: str, value: str) -> None:
108
+ """
109
+ Edits attributes related to a user.
110
+ """
111
+ data = {"key": key, "value": value}
112
+ headers = self._get_user_headers()
113
+ await self._make_request(
114
+ "PUT", f"/ocs/v2.php/cloud/users/{userid}", data=data, headers=headers
115
+ )
116
+
117
+ async def get_editable_user_fields(self) -> List[str]:
118
+ """
119
+ Gets the list of editable data fields for a user.
120
+ """
121
+ headers = self._get_user_headers()
122
+ response = await self._make_request(
123
+ "GET", "/ocs/v2.php/cloud/user/fields", headers=headers
124
+ )
125
+ # The v2 API returns data as a direct list
126
+ data = response.json()["ocs"]["data"]
127
+ return data if isinstance(data, list) else []
128
+
129
+ async def disable_user(self, userid: str) -> None:
130
+ """
131
+ Disables a user on the Nextcloud server.
132
+ """
133
+ headers = self._get_user_headers()
134
+ await self._make_request(
135
+ "PUT", f"/ocs/v2.php/cloud/users/{userid}/disable", headers=headers
136
+ )
137
+
138
+ async def enable_user(self, userid: str) -> None:
139
+ """
140
+ Enables a user on the Nextcloud server.
141
+ """
142
+ headers = self._get_user_headers()
143
+ await self._make_request(
144
+ "PUT", f"/ocs/v2.php/cloud/users/{userid}/enable", headers=headers
145
+ )
146
+
147
+ async def delete_user(self, userid: str) -> None:
148
+ """
149
+ Deletes a user from the Nextcloud server.
150
+ """
151
+ headers = self._get_user_headers()
152
+ await self._make_request(
153
+ "DELETE", f"/ocs/v2.php/cloud/users/{userid}", headers=headers
154
+ )
155
+
156
+ async def get_user_groups(self, userid: str) -> List[str]:
157
+ """
158
+ Retrieves a list of groups the specified user is a member of.
159
+ """
160
+ headers = self._get_user_headers()
161
+ response = await self._make_request(
162
+ "GET", f"/ocs/v2.php/cloud/users/{userid}/groups", headers=headers
163
+ )
164
+ # The v2 API returns groups as a direct list under data.groups
165
+ data = response.json()["ocs"]["data"]
166
+ return data.get("groups", [])
167
+
168
+ async def add_user_to_group(self, userid: str, groupid: str) -> None:
169
+ """
170
+ Adds the specified user to the specified group.
171
+ """
172
+ data = {"groupid": groupid}
173
+ headers = self._get_user_headers()
174
+ await self._make_request(
175
+ "POST",
176
+ f"/ocs/v2.php/cloud/users/{userid}/groups",
177
+ data=data,
178
+ headers=headers,
179
+ )
180
+
181
+ async def remove_user_from_group(self, userid: str, groupid: str) -> None:
182
+ """
183
+ Removes the specified user from the specified group.
184
+ """
185
+ data = {"groupid": groupid}
186
+ headers = self._get_user_headers()
187
+ await self._make_request(
188
+ "DELETE",
189
+ f"/ocs/v2.php/cloud/users/{userid}/groups",
190
+ data=data,
191
+ headers=headers,
192
+ )
193
+
194
+ async def promote_user_to_subadmin(self, userid: str, groupid: str) -> None:
195
+ """
196
+ Makes a user the subadmin of a group.
197
+ """
198
+ data = {"groupid": groupid}
199
+ headers = self._get_user_headers()
200
+ await self._make_request(
201
+ "POST",
202
+ f"/ocs/v2.php/cloud/users/{userid}/subadmins",
203
+ data=data,
204
+ headers=headers,
205
+ )
206
+
207
+ async def demote_user_from_subadmin(self, userid: str, groupid: str) -> None:
208
+ """
209
+ Removes the subadmin rights for the user specified from the group specified.
210
+ """
211
+ data = {"groupid": groupid}
212
+ headers = self._get_user_headers()
213
+ await self._make_request(
214
+ "DELETE",
215
+ f"/ocs/v2.php/cloud/users/{userid}/subadmins",
216
+ data=data,
217
+ headers=headers,
218
+ )
219
+
220
+ async def get_user_subadmin_groups(self, userid: str) -> List[str]:
221
+ """
222
+ Returns the groups in which the user is a subadmin.
223
+ """
224
+ headers = self._get_user_headers()
225
+ response = await self._make_request(
226
+ "GET", f"/ocs/v2.php/cloud/users/{userid}/subadmins", headers=headers
227
+ )
228
+ # The v2 API returns data as a direct list
229
+ data = response.json()["ocs"]["data"]
230
+ return data if isinstance(data, list) else []
231
+
232
+ async def resend_welcome_email(self, userid: str) -> None:
233
+ """
234
+ Triggers the welcome email for this user again.
235
+ """
236
+ headers = self._get_user_headers()
237
+ await self._make_request(
238
+ "POST", f"/ocs/v2.php/cloud/users/{userid}/welcome", headers=headers
239
+ )