notification.py 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. """Pydantic schemas for notification providers."""
  2. from datetime import datetime
  3. from enum import Enum
  4. from typing import Any
  5. from pydantic import BaseModel, Field, field_validator
  6. class ProviderType(str, Enum):
  7. """Supported notification provider types."""
  8. CALLMEBOT = "callmebot"
  9. NTFY = "ntfy"
  10. PUSHOVER = "pushover"
  11. TELEGRAM = "telegram"
  12. EMAIL = "email"
  13. class NotificationProviderBase(BaseModel):
  14. """Base schema for notification providers."""
  15. name: str = Field(..., min_length=1, max_length=100, description="User-defined name")
  16. provider_type: ProviderType = Field(..., description="Type of notification provider")
  17. enabled: bool = Field(default=True, description="Whether notifications are enabled")
  18. config: dict[str, Any] = Field(..., description="Provider-specific configuration")
  19. # Event triggers - print lifecycle
  20. on_print_start: bool = Field(default=False, description="Notify on print start")
  21. on_print_complete: bool = Field(default=True, description="Notify on print complete")
  22. on_print_failed: bool = Field(default=True, description="Notify on print failed")
  23. on_print_stopped: bool = Field(default=True, description="Notify when print is stopped/cancelled")
  24. on_print_progress: bool = Field(default=False, description="Notify at 25%, 50%, 75% progress")
  25. # Event triggers - printer status
  26. on_printer_offline: bool = Field(default=False, description="Notify when printer goes offline")
  27. on_printer_error: bool = Field(default=False, description="Notify on printer errors (AMS, etc.)")
  28. on_filament_low: bool = Field(default=False, description="Notify when filament is running low")
  29. on_maintenance_due: bool = Field(default=False, description="Notify when maintenance is due")
  30. # Quiet hours
  31. quiet_hours_enabled: bool = Field(default=False, description="Enable quiet hours")
  32. quiet_hours_start: str | None = Field(default=None, description="Start time in HH:MM format")
  33. quiet_hours_end: str | None = Field(default=None, description="End time in HH:MM format")
  34. # Daily digest
  35. daily_digest_enabled: bool = Field(default=False, description="Batch notifications into daily digest")
  36. daily_digest_time: str | None = Field(default=None, description="Time to send digest in HH:MM format")
  37. # Printer filter
  38. printer_id: int | None = Field(default=None, description="Specific printer ID or null for all")
  39. @field_validator("quiet_hours_start", "quiet_hours_end", "daily_digest_time")
  40. @classmethod
  41. def validate_time_format(cls, v: str | None) -> str | None:
  42. if v is None:
  43. return v
  44. try:
  45. parts = v.split(":")
  46. if len(parts) != 2:
  47. raise ValueError("Invalid time format")
  48. hour, minute = int(parts[0]), int(parts[1])
  49. if not (0 <= hour <= 23 and 0 <= minute <= 59):
  50. raise ValueError("Invalid time range")
  51. return f"{hour:02d}:{minute:02d}"
  52. except (ValueError, TypeError):
  53. raise ValueError("Time must be in HH:MM format (e.g., 22:00)")
  54. class NotificationProviderCreate(NotificationProviderBase):
  55. """Schema for creating a notification provider."""
  56. pass
  57. class NotificationProviderUpdate(BaseModel):
  58. """Schema for updating a notification provider (all fields optional)."""
  59. name: str | None = Field(default=None, min_length=1, max_length=100)
  60. provider_type: ProviderType | None = None
  61. enabled: bool | None = None
  62. config: dict[str, Any] | None = None
  63. # Event triggers - print lifecycle
  64. on_print_start: bool | None = None
  65. on_print_complete: bool | None = None
  66. on_print_failed: bool | None = None
  67. on_print_stopped: bool | None = None
  68. on_print_progress: bool | None = None
  69. # Event triggers - printer status
  70. on_printer_offline: bool | None = None
  71. on_printer_error: bool | None = None
  72. on_filament_low: bool | None = None
  73. on_maintenance_due: bool | None = None
  74. # Quiet hours
  75. quiet_hours_enabled: bool | None = None
  76. quiet_hours_start: str | None = None
  77. quiet_hours_end: str | None = None
  78. # Daily digest
  79. daily_digest_enabled: bool | None = None
  80. daily_digest_time: str | None = None
  81. # Printer filter
  82. printer_id: int | None = None
  83. class NotificationProviderResponse(NotificationProviderBase):
  84. """Schema for notification provider API responses."""
  85. id: int
  86. last_success: datetime | None = None
  87. last_error: str | None = None
  88. last_error_at: datetime | None = None
  89. created_at: datetime
  90. updated_at: datetime
  91. class Config:
  92. from_attributes = True
  93. class NotificationTestRequest(BaseModel):
  94. """Schema for testing notification configuration."""
  95. provider_type: ProviderType
  96. config: dict[str, Any]
  97. class NotificationTestResponse(BaseModel):
  98. """Schema for test notification response."""
  99. success: bool
  100. message: str
  101. # Provider-specific config schemas for documentation/validation reference
  102. class CallMeBotConfig(BaseModel):
  103. """CallMeBot/WhatsApp configuration."""
  104. phone: str = Field(..., description="Phone number with country code (e.g., +1234567890)")
  105. apikey: str = Field(..., description="API key from CallMeBot")
  106. class NtfyConfig(BaseModel):
  107. """ntfy configuration."""
  108. server: str = Field(default="https://ntfy.sh", description="ntfy server URL")
  109. topic: str = Field(..., description="Topic name to publish to")
  110. auth_token: str | None = Field(default=None, description="Optional authentication token")
  111. class PushoverConfig(BaseModel):
  112. """Pushover configuration."""
  113. user_key: str = Field(..., description="Your Pushover user key")
  114. app_token: str = Field(..., description="Your Pushover application token")
  115. priority: int = Field(default=0, ge=-2, le=2, description="Message priority (-2 to 2)")
  116. class TelegramConfig(BaseModel):
  117. """Telegram bot configuration."""
  118. bot_token: str = Field(..., description="Bot token from @BotFather")
  119. chat_id: str = Field(..., description="Chat ID to send messages to")
  120. class EmailConfig(BaseModel):
  121. """Email/SMTP configuration."""
  122. smtp_server: str = Field(..., description="SMTP server hostname")
  123. smtp_port: int = Field(default=587, description="SMTP port (587 for TLS, 465 for SSL)")
  124. username: str = Field(..., description="SMTP username/email")
  125. password: str = Field(..., description="SMTP password or app password")
  126. from_email: str = Field(..., description="From email address")
  127. to_email: str = Field(..., description="Recipient email address")
  128. use_tls: bool = Field(default=True, description="Use TLS encryption")
  129. # Notification Log schemas
  130. class NotificationLogResponse(BaseModel):
  131. """Schema for notification log API responses."""
  132. id: int
  133. provider_id: int
  134. provider_name: str | None = None
  135. provider_type: str | None = None
  136. event_type: str
  137. title: str
  138. message: str
  139. success: bool
  140. error_message: str | None = None
  141. printer_id: int | None = None
  142. printer_name: str | None = None
  143. created_at: datetime
  144. class Config:
  145. from_attributes = True
  146. class NotificationLogStats(BaseModel):
  147. """Statistics for notification logs."""
  148. total: int
  149. success_count: int
  150. failure_count: int
  151. by_event_type: dict[str, int]
  152. by_provider: dict[str, int]