supernote 0.13.6__py3-none-any.whl

supernote/models/equipment.py

@@ -0,0 +1,276 @@
+"""Equipment related API data models mirroring OpenAPI Spec.
+
+The following endpoints are supported:
+- /api/terminal/user/activateEquipment
+- /api/terminal/user/bindEquipment
+- /api/terminal/equipment/unlink
+- /api/equipment/bind/status
+- /api/equipment/query/by/equipmentno
+- /api/equipment/manual/deleteApi
+- /api/equipment/query/by/{userId}
+"""
+
+from dataclasses import dataclass, field
+
+from mashumaro import field_options
+from mashumaro.config import BaseConfig
+from mashumaro.mixins.json import DataClassJSONMixin
+
+from .base import BaseResponse, BooleanEnum
+
+
+@dataclass
+class ActivateEquipmentDTO(DataClassJSONMixin):
+    """Request to activate equipment.
+
+    Used by:
+        /api/terminal/user/activateEquipment (POST)
+    """
+
+    equipment_no: str = field(metadata=field_options(alias="equipmentNo"))
+    """Device serial number."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class BindEquipmentDTO(DataClassJSONMixin):
+    """Request to bind equipment.
+
+    Used by:
+        /api/terminal/user/bindEquipment (POST)
+    """
+
+    equipment_no: str = field(metadata=field_options(alias="equipmentNo"))
+    """Device serial number."""
+
+    account: str
+    """User account."""
+
+    name: str
+    """Device name."""
+
+    total_capacity: str = field(metadata=field_options(alias="totalCapacity"))
+    """Total device capacity."""
+
+    flag: str | None = None
+    """Identifier (Fixed value: 1)."""
+
+    label: list[str] = field(default_factory=list)
+    """Labels."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class UnbindEquipmentDTO(DataClassJSONMixin):
+    """Request to unbind equipment.
+
+    Used by:
+        /api/terminal/equipment/unlink (POST)
+    """
+
+    equipment_no: str = field(metadata=field_options(alias="equipmentNo"))
+    """Device serial number."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class QueryEquipmentDTO(DataClassJSONMixin):
+    """Request to query equipment list.
+
+    Used by:
+        /api/equipment/query/user/equipment/deleteApi (POST)
+    """
+
+    page_no: str = field(metadata=field_options(alias="pageNo"))
+    """Page number."""
+
+    page_size: str = field(metadata=field_options(alias="pageSize"))
+    """Page size."""
+
+    equipment_number: str | None = field(
+        metadata=field_options(alias="equipmentNumber"), default=None
+    )
+    """Equipment number."""
+
+    firmware_version: str | None = field(
+        metadata=field_options(alias="firmwareVersion"), default=None
+    )
+    """Firmware version."""
+
+    country_code: str | None = field(
+        metadata=field_options(alias="countryCode"), default=None
+    )
+    """Country code."""
+
+    telephone: str | None = field(default=None)
+    """Telephone."""
+
+    email: str | None = field(default=None)
+    """Email."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class UserEquipmentDTO(DataClassJSONMixin):
+    """Request to query user equipment.
+
+    Used by:
+        /api/equipment/query/by/equipmentno (POST)
+    """
+
+    equipment_no: str = field(metadata=field_options(alias="equipmentNo"))
+    """Device serial number."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class EquipmentManualDTO(DataClassJSONMixin):
+    """Request for equipment manual.
+
+    Used by:
+        /api/equipment/manual/deleteApi (POST)
+    """
+
+    equipment_no: str = field(metadata=field_options(alias="equipmentNo"))
+    """Device serial number."""
+
+    language: str
+    """Language (JP, CN, HK, EN)."""
+
+    logic_version: str = field(metadata=field_options(alias="logicVersion"))
+    """Logic version number."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass(kw_only=True)
+class BindStatusVO(BaseResponse):
+    """Response for bind status.
+
+    Used by:
+        /api/equipment/bind/status (POST)
+    """
+
+    bind_status: bool | None = field(
+        metadata=field_options(alias="bindStatus"), default=None
+    )
+    """Bind status (true: bound, false: unbound)."""
+
+
+@dataclass(kw_only=True)
+class EquipmentManualVO(BaseResponse):
+    """Response for equipment manual.
+
+    Used by:
+        /api/equipment/manual/deleteApi (POST)
+    """
+
+    equipment_no: str | None = field(
+        metadata=field_options(alias="equipmentNo"), default=None
+    )
+    url: str | None = None
+    md5: str | None = None
+    file_name: str | None = field(
+        metadata=field_options(alias="fileName"), default=None
+    )
+    version: str | None = None
+
+
+@dataclass
+class EquipmentVO(DataClassJSONMixin):
+    """Equipment details object."""
+
+    equipment_number: str | None = field(
+        metadata=field_options(alias="equipmentNumber"), default=None
+    )
+    firmware_version: str | None = field(
+        metadata=field_options(alias="firmwareVersion"), default=None
+    )
+    update_status: str | None = field(
+        metadata=field_options(alias="updateStatus"), default=None
+    )
+    remark: str | None = None
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass(kw_only=True)
+class UserEquipmentVO(BaseResponse):
+    """User equipment details response.
+
+    Used by:
+        /api/equipment/query/by/equipmentno (POST)
+    """
+
+    equipment_number: str | None = field(
+        metadata=field_options(alias="equipmentNumber"), default=None
+    )
+    user_id: int | None = field(metadata=field_options(alias="userId"), default=None)
+    name: str | None = None
+    status: str | None = None
+
+
+@dataclass(kw_only=True)
+class UserEquipmentListVO(BaseResponse):
+    """List of user equipment.
+
+    Used by:
+        /api/equipment/query/by/{userId} (GET)
+    """
+
+    equipment_vo_list: list[UserEquipmentVO] = field(
+        metadata=field_options(alias="equipmentVOList"), default_factory=list
+    )
+
+
+@dataclass
+class QueryEquipmentVO(DataClassJSONMixin):
+    """Detailed equipment query response object."""
+
+    user_id: str | None = field(metadata=field_options(alias="userId"), default=None)
+    equipment_number: str | None = field(
+        metadata=field_options(alias="equipmentNumber"), default=None
+    )
+    name: str | None = None
+    firmware_version: str | None = field(
+        metadata=field_options(alias="firmwareVersion"), default=None
+    )
+    create_time: int | None = field(
+        metadata=field_options(alias="createTime"), default=None
+    )
+    activate_time: int | None = field(
+        metadata=field_options(alias="activateTime"), default=None
+    )
+    country_code: str | None = field(
+        metadata=field_options(alias="countryCode"), default=None
+    )
+    telephone: str | None = None
+    email: str | None = None
+    status: BooleanEnum | None = None
+    """Device status (e.g., Y: Active, N: Inactive)."""
+
+    update_status: str | None = field(
+        metadata=field_options(alias="updateStatus"), default=None
+    )
+    """Firmware update status."""
+
+    remark: str | None = None
+    """Remark or note."""
+    file_server: str | None = field(
+        metadata=field_options(alias="fileServer"), default=None
+    )
+
+    class Config(BaseConfig):
+        serialize_by_alias = True

supernote/models/extended.py

@@ -0,0 +1,124 @@
+"""Module for server-specific extension models.
+
+These are for APIs that are not part of the standard API offering, specific
+to our new server.
+"""
+
+from dataclasses import dataclass, field
+
+from mashumaro import field_options
+from mashumaro.config import BaseConfig
+from mashumaro.mixins.json import DataClassJSONMixin
+
+from supernote.models.base import BaseResponse, ProcessingStatus
+from supernote.models.summary import SummaryItem
+
+
+@dataclass
+class WebSummaryListRequestDTO(DataClassJSONMixin):
+    """Request DTO for listing summaries by file ID (Web Extension)."""
+
+    file_id: int = field(metadata=field_options(alias="fileId"))
+    """The ID of the file to list summaries for."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class WebSummaryListVO(BaseResponse):
+    """Response VO for listing summaries (Web Extension).
+
+    Used by: POST /api/extended/file/summary/list
+    """
+
+    summary_do_list: list[SummaryItem] = field(
+        metadata=field_options(alias="summaryDOList"), default_factory=list
+    )
+    """List of summary items found for the file."""
+
+    total_records: int = field(metadata=field_options(alias="totalRecords"), default=0)
+    """Total count of summaries returned."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class SystemTaskVO(DataClassJSONMixin):
+    """VO for a system processing task.
+
+    Used by: GET /api/extended/system/tasks
+    """
+
+    id: int
+    """The unique ID of the system task."""
+
+    file_id: int = field(metadata=field_options(alias="fileId"))
+    """The ID of the file associated with this task."""
+
+    task_type: str = field(metadata=field_options(alias="taskType"))
+    """The type of task (e.g. 'OCR', 'SUMMARY')."""
+
+    key: str
+    """The specific key for the task (e.g. 'page_1', 'global')."""
+
+    status: ProcessingStatus
+    """The current status (PENDING, PROCESSING, COMPLETED, FAILED)."""
+
+    retry_count: int = field(metadata=field_options(alias="retryCount"))
+    """Number of times the task has been retried."""
+
+    update_time: int = field(metadata=field_options(alias="updateTime"))
+    """Timestamp of the last update (ms)."""
+
+    last_error: str | None = field(
+        metadata=field_options(alias="lastError"), default=None
+    )
+    """Error message from the last failure, if any."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class SystemTaskListVO(BaseResponse):
+    """Response VO for listing system tasks.
+
+    Used by: GET /api/extended/system/tasks
+    """
+
+    tasks: list[SystemTaskVO] = field(default_factory=list)
+    """List of recent system tasks."""
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class FileProcessingStatusDTO(DataClassJSONMixin):
+    """Request model for querying processing status of files.
+
+    Used by:
+        /api/extended/file/processing/status (POST)
+    """
+
+    file_ids: list[int] = field(metadata=field_options(alias="fileIds"))
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class FileProcessingStatusVO(BaseResponse):
+    """Response model for file processing status.
+
+    Used by:
+        /api/extended/file/processing/status (POST)
+    """
+
+    # Map of file_id -> status summary
+    # status: PENDING, PROCESSING, COMPLETED, FAILED
+    status_map: dict[str, ProcessingStatus] = field(
+        metadata=field_options(alias="statusMap"), default_factory=dict
+    )

supernote/models/file_common.py

@@ -0,0 +1,95 @@
+from dataclasses import dataclass, field
+
+from mashumaro import field_options
+from mashumaro.config import BaseConfig
+from mashumaro.mixins.json import DataClassJSONMixin
+
+from .base import BaseEnum, BaseResponse
+
+
+class FileSortOrder(str, BaseEnum):
+    """Sort order for file listing."""
+
+    FILENAME = "filename"
+    TIME = "time"
+    SIZE = "size"
+
+
+class FileSortSequence(str, BaseEnum):
+    """Sort sequence for file listing."""
+
+    ASC = "asc"
+    DESC = "desc"
+
+
+class DownloadType(str, BaseEnum):
+    """Download type."""
+
+    DOWNLOAD = "0"
+    SHARE = "1"
+
+
+class UploadType(str, BaseEnum):
+    """Upload type."""
+
+    APP = "1"
+    CLOUD = "2"
+
+
+@dataclass
+class EntriesVO(DataClassJSONMixin):
+    """Object representing a file entry (Device)."""
+
+    id: str
+    name: str
+    tag: str = ""
+    path_display: str = field(metadata=field_options(alias="path_display"), default="")
+    content_hash: str | None = field(
+        metadata=field_options(alias="content_hash"), default=None
+    )
+    is_downloadable: bool = field(
+        metadata=field_options(alias="is_downloadable"), default=True
+    )
+    size: int = 0
+    last_update_time: int = field(
+        metadata=field_options(alias="lastUpdateTime"), default=0
+    )
+    parent_path: str = field(metadata=field_options(alias="parent_path"), default="")
+
+    class Config(BaseConfig):
+        serialize_by_alias = True
+
+
+@dataclass
+class FileUploadApplyLocalVO(BaseResponse):
+    """Response model containing upload credentials/URLs.
+
+    This is used by the following POST endpoint:
+        /api/file/upload/apply
+        /api/file/terminal/upload/apply
+    """
+
+    equipment_no: str | None = field(
+        metadata=field_options(alias="equipmentNo"), default=None
+    )
+    bucket_name: str | None = field(
+        metadata=field_options(alias="bucketName"), default=None
+    )
+    """In private clouds, typically 'supernote'."""
+
+    inner_name: str | None = field(
+        metadata=field_options(alias="innerName"), default=None
+    )
+    """Obfuscated storage key. Formula: {UUID}-{tail}.{ext} where tail is SN last 3 digits."""
+
+    x_amz_date: str | None = field(
+        metadata=field_options(alias="xAmzDate"), default=None
+    )
+    authorization: str | None = None
+    """The signature for the upload request which should be passed in the x-access-token header."""
+    full_upload_url: str | None = field(
+        metadata=field_options(alias="fullUploadUrl"), default=None
+    )
+    part_upload_url: str | None = field(
+        metadata=field_options(alias="partUploadUrl"), default=None
+    )