-
Notifications
You must be signed in to change notification settings - Fork 699
Expand file tree
/
Copy pathschemas.py
More file actions
574 lines (440 loc) · 16.7 KB
/
Copy pathschemas.py
File metadata and controls
574 lines (440 loc) · 16.7 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
"""Pydantic schemas for request/response validation."""
import uuid
from datetime import datetime
from pydantic import BaseModel, EmailStr, Field
# ─── Auth ───────────────────────────────────────────────
class UserRegister(BaseModel):
"""Legacy combined registration - kept for backward compatibility."""
username: str = Field(min_length=1, max_length=100)
email: EmailStr
password: str = Field(min_length=6, max_length=128)
display_name: str | None = None
invitation_code: str | None = None
# SSO registration fields
provider: str | None = Field(None, description="Provider type for SSO registration (feishu, dingtalk, etc.)")
provider_code: str | None = Field(None, description="OAuth code for SSO registration")
class RegisterInitRequest(BaseModel):
"""Step 1: Initialize registration with account credentials."""
username: str = Field(min_length=1, max_length=100)
email: EmailStr
password: str = Field(min_length=6, max_length=128)
display_name: str | None = None
target_tenant_id: uuid.UUID | None = None
class RegisterInitResponse(BaseModel):
"""Response after step 1 - user created, needs email verification."""
user_id: uuid.UUID
email: str
access_token: str
message: str = "Registration initiated. Please verify your email."
user: "UserOut" # Include full user info
needs_company_setup: bool = True
target_tenant_id: uuid.UUID | None = None
class RegisterCompleteRequest(BaseModel):
"""Step 3: Complete registration after email verification."""
token: str = Field(min_length=6, max_length=512, description="Email verification code")
class RegisterCompleteResponse(BaseModel):
"""Response after successful registration completion."""
access_token: str
token_type: str = "bearer"
user: "UserOut"
needs_company_setup: bool = False
class SSORegisterRequest(BaseModel):
"""SSO registration - completely separate from normal registration."""
provider: str = Field(description="Provider type (feishu, dingtalk, etc.)")
code: str = Field(description="OAuth authorization code from provider")
invitation_code: str | None = None
class UserLogin(BaseModel):
login_identifier: str = Field(description="Email address for login")
password: str
tenant_id: uuid.UUID | None = None # Optional: when set, restrict login to users of this tenant
class ForgotPasswordRequest(BaseModel):
email: EmailStr
class ResetPasswordRequest(BaseModel):
token: str = Field(min_length=20, max_length=512)
new_password: str = Field(min_length=6, max_length=128)
class VerifyEmailRequest(BaseModel):
token: str = Field(min_length=6, max_length=512)
class ResendVerificationRequest(BaseModel):
email: EmailStr
class NeedsVerificationResponse(BaseModel):
"""Response when user needs to verify email before continuing."""
needs_verification: bool = True
email: str
message: str = "Email already registered but not verified. Please enter the verification code."
class TokenResponse(BaseModel):
access_token: str
token_type: str = "bearer"
user: "UserOut"
identity: "IdentityOut | None" = None
needs_company_setup: bool = False
tenant_name: str | None = None
class TenantChoice(BaseModel):
"""Multi-tenant login: tenant selection info."""
tenant_id: uuid.UUID | None
tenant_name: str
tenant_slug: str
class MultiTenantResponse(BaseModel):
"""Response when multiple tenants match the same login identifier."""
requires_tenant_selection: bool = True
login_identifier: str
tenants: list[TenantChoice]
class TenantSwitchRequest(BaseModel):
tenant_id: uuid.UUID
class TenantSwitchResponse(BaseModel):
access_token: str
token_type: str = "bearer"
redirect_url: str | None = None
message: str | None = None
class IdentityOut(BaseModel):
"""Global identity information."""
id: uuid.UUID
email: str | None = None
phone: str | None = None
username: str | None = None
is_active: bool
is_platform_admin: bool
email_verified: bool
created_at: datetime
updated_at: datetime
model_config = {"from_attributes": True}
class UserOut(BaseModel):
id: uuid.UUID
identity_id: uuid.UUID | None = None
username: str | None = None
email: str | None = None
display_name: str
avatar_url: str | None = None
role: str
tenant_id: uuid.UUID | None = None
title: str | None = None
primary_mobile: str | None = None
registration_source: str | None = None
is_active: bool
email_verified: bool = True
created_at: datetime
model_config = {"from_attributes": True}
class IdentityProviderOut(BaseModel):
id: uuid.UUID
provider_type: str
name: str
is_active: bool
sso_login_enabled: bool = False
config: dict | None = None
tenant_id: uuid.UUID | None = None
updated_at: datetime | None = None
created_at: datetime
sso_domain: str | None = None
model_config = {"from_attributes": True}
class OAuthAuthorizeResponse(BaseModel):
authorization_url: str
class OAuthCallbackRequest(BaseModel):
code: str
state: str
class IdentityBindRequest(BaseModel):
provider_type: str
code: str # OAuth code for binding
class IdentityUnbindRequest(BaseModel):
provider_type: str
class UserUpdate(BaseModel):
username: str | None = None
email: EmailStr | None = None
display_name: str | None = None
avatar_url: str | None = None
title: str | None = None
primary_mobile: str | None = None
# ─── Agent ──────────────────────────────────────────────
class AgentCreate(BaseModel):
name: str = Field(min_length=2, max_length=100, description="Agent name, 2-100 characters")
agent_type: str = "native" # native | openclaw
role_description: str = Field(default="", max_length=500, description="Role description, max 500 characters")
bio: str | None = None
welcome_message: str | None = None
avatar_url: str | None = None
# Soul
personality: str = ""
boundaries: str = ""
# Model
primary_model_id: uuid.UUID | None = None
fallback_model_id: uuid.UUID | None = None
# Permissions
permission_scope_type: str = "company" # company | user (only me) | user_group (specific users)
permission_scope_ids: list[uuid.UUID] = []
permission_access_level: str = "use" # use | manage
user_permissions: dict[str, str] | None = None # {user_id: access_level} for per-user permissions
# Target tenant (admin-only override; otherwise ignored)
tenant_id: uuid.UUID | None = None
# Template
template_id: uuid.UUID | None = None
# Autonomy
autonomy_policy: dict | None = None
# Token limits
max_tokens_per_day: int | None = None
max_tokens_per_month: int | None = None
# Skills to copy into agent workspace
skill_ids: list[uuid.UUID] = []
class AgentOut(BaseModel):
id: uuid.UUID
name: str
avatar_url: str | None = None
role_description: str
bio: str | None = None
welcome_message: str | None = None
status: str
creator_id: uuid.UUID
creator_username: str | None = None # Populated by API layer; not in ORM model directly
primary_model_id: uuid.UUID | None = None
fallback_model_id: uuid.UUID | None = None
autonomy_policy: dict
tokens_used_today: int
tokens_used_month: int
tokens_used_total: int = 0
max_tokens_per_day: int | None = None
max_tokens_per_month: int | None = None
context_window_size: int = 100
max_tool_rounds: int = 50
max_triggers: int = 20
min_poll_interval_min: int = 5
webhook_rate_limit: int = 5
heartbeat_enabled: bool = True
heartbeat_interval_minutes: int = 240
heartbeat_active_hours: str = "09:00-18:00"
last_heartbeat_at: datetime | None = None
timezone: str | None = None
expires_at: datetime | None = None
is_expired: bool = False
llm_calls_today: int = 0
max_llm_calls_per_day: int = 100
agent_type: str = "native"
openclaw_last_seen: datetime | None = None
has_api_key: bool = False
api_key_hash: str | None = None
created_at: datetime
last_active_at: datetime | None = None
model_config = {"from_attributes": True}
class AgentUpdate(BaseModel):
name: str | None = None
role_description: str | None = None
bio: str | None = None
welcome_message: str | None = None
avatar_url: str | None = None
autonomy_policy: dict | None = None
primary_model_id: uuid.UUID | None = None
fallback_model_id: uuid.UUID | None = None
context_window_size: int | None = Field(default=None, ge=1, le=500)
max_tokens_per_day: int | None = None
max_tokens_per_month: int | None = None
max_tool_rounds: int | None = None
max_triggers: int | None = None
min_poll_interval_min: int | None = None
webhook_rate_limit: int | None = None
heartbeat_enabled: bool | None = None
heartbeat_interval_minutes: int | None = None
heartbeat_active_hours: str | None = None
timezone: str | None = None
expires_at: datetime | None = None # Admin only — extend agent expiry
class AgentStatusOut(BaseModel):
"""Agent status from state.json."""
agent_id: uuid.UUID
name: str
status: str
current_task: str | None = None
last_active: datetime | None = None
channel_status: dict = {}
stats: dict = {}
# ─── Task ───────────────────────────────────────────────
class TaskCreate(BaseModel):
title: str = Field(min_length=1, max_length=500)
description: str | None = None
type: str = "todo" # todo | supervision
priority: str = "medium"
due_date: datetime | None = None
# Supervision fields
supervision_target_name: str | None = None
supervision_channel: str | None = None
remind_schedule: str | None = None
class TaskOut(BaseModel):
id: uuid.UUID
agent_id: uuid.UUID
title: str
description: str | None = None
type: str
status: str
priority: str
assignee: str
created_by: uuid.UUID
creator_username: str | None = None
due_date: datetime | None = None
supervision_target_name: str | None = None
supervision_channel: str | None = None
remind_schedule: str | None = None
created_at: datetime
updated_at: datetime
completed_at: datetime | None = None
model_config = {"from_attributes": True}
class TaskUpdate(BaseModel):
title: str | None = None
description: str | None = None
status: str | None = None
priority: str | None = None
due_date: datetime | None = None
supervision_target_name: str | None = None
remind_schedule: str | None = None
class TaskLogCreate(BaseModel):
content: str
class TaskLogOut(BaseModel):
id: uuid.UUID
task_id: uuid.UUID
content: str
created_at: datetime
model_config = {"from_attributes": True}
# ─── LLM ────────────────────────────────────────────────
class LLMModelCreate(BaseModel):
provider: str
model: str
api_key: str
base_url: str | None = None
label: str
temperature: float | None = Field(None, ge=0.0, le=2.0)
max_tokens_per_day: int | None = None
enabled: bool = True
supports_vision: bool = False
max_output_tokens: int | None = None
request_timeout: int | None = None
class LLMModelUpdate(BaseModel):
provider: str | None = None
model: str | None = None
api_key: str | None = None
base_url: str | None = None
label: str | None = None
temperature: float | None = Field(None, ge=0.0, le=2.0)
max_tokens_per_day: int | None = None
enabled: bool | None = None
supports_vision: bool | None = None
max_output_tokens: int | None = None
request_timeout: int | None = None
class LLMModelOut(BaseModel):
id: uuid.UUID
provider: str
model: str
base_url: str | None = None
label: str
temperature: float | None = None
api_key_masked: str = ""
max_tokens_per_day: int | None = None
enabled: bool
supports_vision: bool = False
max_output_tokens: int | None = None
request_timeout: int | None = None
created_at: datetime
model_config = {"from_attributes": True}
# ─── Channel Config ─────────────────────────────────────
class ChannelConfigCreate(BaseModel):
channel_type: str = "feishu"
app_id: str
app_secret: str
encrypt_key: str | None = None
verification_token: str | None = None
extra_config: dict | None = None
class ChannelConfigOut(BaseModel):
id: uuid.UUID
agent_id: uuid.UUID
channel_type: str
app_id: str | None = None
app_secret: str | None = None
encrypt_key: str | None = None
is_configured: bool
is_connected: bool
last_tested_at: datetime | None = None
extra_config: dict | None = None
created_at: datetime
model_config = {"from_attributes": True}
# ─── Approval ───────────────────────────────────────────
class ApprovalRequestOut(BaseModel):
id: uuid.UUID
agent_id: uuid.UUID
agent_name: str | None = None
action_type: str
details: dict
status: str
created_at: datetime
resolved_at: datetime | None = None
resolved_by: uuid.UUID | None = None
model_config = {"from_attributes": True}
class ApprovalAction(BaseModel):
action: str # "approve" | "reject"
# ─── Enterprise Info ────────────────────────────────────
class UserInviteRequest(BaseModel):
emails: list[EmailStr] = Field(..., description="List of emails to invite")
class EnterpriseInfoUpdate(BaseModel):
content: dict
visible_roles: list[str] = []
class EnterpriseInfoOut(BaseModel):
id: uuid.UUID
info_type: str
content: dict
version: int
visible_roles: list
updated_at: datetime
model_config = {"from_attributes": True}
# ─── Chat ───────────────────────────────────────────────
class ChatMessageOut(BaseModel):
id: uuid.UUID
agent_id: uuid.UUID
user_id: uuid.UUID
role: str
content: str
thinking: str | None = None
created_at: datetime
model_config = {"from_attributes": True}
class ChatSend(BaseModel):
content: str = Field(min_length=1)
# ─── Audit Log ──────────────────────────────────────────
class AuditLogOut(BaseModel):
id: uuid.UUID
user_id: uuid.UUID | None = None
agent_id: uuid.UUID | None = None
action: str
details: dict
ip_address: str | None = None
created_at: datetime
model_config = {"from_attributes": True}
# ─── Generic ────────────────────────────────────────────
class PaginatedResponse(BaseModel):
items: list
total: int
page: int = 1
page_size: int = 20
class HealthResponse(BaseModel):
status: str = "ok"
version: str
# ─── Gateway (OpenClaw) ─────────────────────────────────
class GatewayHistoryItem(BaseModel):
role: str # "user" or "assistant"
content: str
sender_name: str | None = None
created_at: datetime
class GatewayRelationshipItem(BaseModel):
name: str
type: str # "human" or "agent"
role: str | None = None # e.g. "collaborator", "supervisor"
description: str | None = None
channels: list[str] = [] # e.g. ["feishu"], ["agent"]
class GatewayMessageOut(BaseModel):
id: uuid.UUID
conversation_id: str | None = None
sender_agent_name: str | None = None
sender_user_name: str | None = None
sender_user_id: str | None = None
content: str
created_at: datetime
history: list[GatewayHistoryItem] = []
class GatewayPollResponse(BaseModel):
messages: list[GatewayMessageOut] = []
relationships: list[GatewayRelationshipItem] = []
class GatewayReportRequest(BaseModel):
message_id: uuid.UUID
result: str = Field(min_length=1)
class GatewaySendMessageRequest(BaseModel):
target: str # Name of target person or agent
content: str = Field(min_length=1)
channel: str | None = None # Optional: "feishu", "agent", etc. Auto-detected if omitted.