skillforge-client 0.3.0__py3-none-any.whl

skillforge_client/models/operation_page.py

@@ -0,0 +1,100 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ..models.operation_summary import OperationSummary
+
+
+T = TypeVar("T", bound="OperationPage")
+
+
+@_attrs_define
+class OperationPage:
+    """A page of operations plus the total match count, for offset pagination.
+
+    Attributes:
+        items (list[OperationSummary]):
+        limit (int):
+        offset (int):
+        total (int):
+    """
+
+    items: list[OperationSummary]
+    limit: int
+    offset: int
+    total: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        items = []
+        for items_item_data in self.items:
+            items_item = items_item_data.to_dict()
+            items.append(items_item)
+
+        limit = self.limit
+
+        offset = self.offset
+
+        total = self.total
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "items": items,
+                "limit": limit,
+                "offset": offset,
+                "total": total,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.operation_summary import OperationSummary
+
+        d = dict(src_dict)
+        items = []
+        _items = d.pop("items")
+        for items_item_data in _items:
+            items_item = OperationSummary.from_dict(items_item_data)
+
+            items.append(items_item)
+
+        limit = d.pop("limit")
+
+        offset = d.pop("offset")
+
+        total = d.pop("total")
+
+        operation_page = cls(
+            items=items,
+            limit=limit,
+            offset=offset,
+            total=total,
+        )
+
+        operation_page.additional_properties = d
+        return operation_page
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

skillforge_client/models/operation_response.py

@@ -0,0 +1,257 @@
+from __future__ import annotations
+
+import datetime
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar, cast
+from uuid import UUID
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.operation_kind import OperationKind
+from ..models.operation_status import OperationStatus
+
+if TYPE_CHECKING:
+    from ..models.operation_response_plan import OperationResponsePlan
+
+
+T = TypeVar("T", bound="OperationResponse")
+
+
+@_attrs_define
+class OperationResponse:
+    """Full read view of a single operation, including the two-phase ``plan``.
+
+    Attributes:
+        cancelled_at (datetime.datetime | None):
+        committed_at (datetime.datetime | None):
+        created_at (datetime.datetime):
+        expires_at (datetime.datetime):
+        failed_at (datetime.datetime | None):
+        guild_id (int):
+        kind (OperationKind):
+        last_error (None | str):
+        operation_id (UUID):
+        plan (OperationResponsePlan):
+        reserved_archive_category_channel_id (int | None):
+        status (OperationStatus):
+        subject_discord_id (int):
+        tutor_discord_id (int | None):
+        updated_at (datetime.datetime):
+    """
+
+    cancelled_at: datetime.datetime | None
+    committed_at: datetime.datetime | None
+    created_at: datetime.datetime
+    expires_at: datetime.datetime
+    failed_at: datetime.datetime | None
+    guild_id: int
+    kind: OperationKind
+    last_error: None | str
+    operation_id: UUID
+    plan: OperationResponsePlan
+    reserved_archive_category_channel_id: int | None
+    status: OperationStatus
+    subject_discord_id: int
+    tutor_discord_id: int | None
+    updated_at: datetime.datetime
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        cancelled_at: None | str
+        if isinstance(self.cancelled_at, datetime.datetime):
+            cancelled_at = self.cancelled_at.isoformat()
+        else:
+            cancelled_at = self.cancelled_at
+
+        committed_at: None | str
+        if isinstance(self.committed_at, datetime.datetime):
+            committed_at = self.committed_at.isoformat()
+        else:
+            committed_at = self.committed_at
+
+        created_at = self.created_at.isoformat()
+
+        expires_at = self.expires_at.isoformat()
+
+        failed_at: None | str
+        if isinstance(self.failed_at, datetime.datetime):
+            failed_at = self.failed_at.isoformat()
+        else:
+            failed_at = self.failed_at
+
+        guild_id = self.guild_id
+
+        kind = self.kind.value
+
+        last_error: None | str
+        last_error = self.last_error
+
+        operation_id = str(self.operation_id)
+
+        plan = self.plan.to_dict()
+
+        reserved_archive_category_channel_id: int | None
+        reserved_archive_category_channel_id = self.reserved_archive_category_channel_id
+
+        status = self.status.value
+
+        subject_discord_id = self.subject_discord_id
+
+        tutor_discord_id: int | None
+        tutor_discord_id = self.tutor_discord_id
+
+        updated_at = self.updated_at.isoformat()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "cancelled_at": cancelled_at,
+                "committed_at": committed_at,
+                "created_at": created_at,
+                "expires_at": expires_at,
+                "failed_at": failed_at,
+                "guild_id": guild_id,
+                "kind": kind,
+                "last_error": last_error,
+                "operation_id": operation_id,
+                "plan": plan,
+                "reserved_archive_category_channel_id": reserved_archive_category_channel_id,
+                "status": status,
+                "subject_discord_id": subject_discord_id,
+                "tutor_discord_id": tutor_discord_id,
+                "updated_at": updated_at,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.operation_response_plan import OperationResponsePlan
+
+        d = dict(src_dict)
+
+        def _parse_cancelled_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                cancelled_at_type_0 = datetime.datetime.fromisoformat(data)
+
+                return cancelled_at_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        cancelled_at = _parse_cancelled_at(d.pop("cancelled_at"))
+
+        def _parse_committed_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                committed_at_type_0 = datetime.datetime.fromisoformat(data)
+
+                return committed_at_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        committed_at = _parse_committed_at(d.pop("committed_at"))
+
+        created_at = datetime.datetime.fromisoformat(d.pop("created_at"))
+
+        expires_at = datetime.datetime.fromisoformat(d.pop("expires_at"))
+
+        def _parse_failed_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                failed_at_type_0 = datetime.datetime.fromisoformat(data)
+
+                return failed_at_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        failed_at = _parse_failed_at(d.pop("failed_at"))
+
+        guild_id = d.pop("guild_id")
+
+        kind = OperationKind(d.pop("kind"))
+
+        def _parse_last_error(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        last_error = _parse_last_error(d.pop("last_error"))
+
+        operation_id = UUID(d.pop("operation_id"))
+
+        plan = OperationResponsePlan.from_dict(d.pop("plan"))
+
+        def _parse_reserved_archive_category_channel_id(data: object) -> int | None:
+            if data is None:
+                return data
+            return cast(int | None, data)
+
+        reserved_archive_category_channel_id = _parse_reserved_archive_category_channel_id(
+            d.pop("reserved_archive_category_channel_id")
+        )
+
+        status = OperationStatus(d.pop("status"))
+
+        subject_discord_id = d.pop("subject_discord_id")
+
+        def _parse_tutor_discord_id(data: object) -> int | None:
+            if data is None:
+                return data
+            return cast(int | None, data)
+
+        tutor_discord_id = _parse_tutor_discord_id(d.pop("tutor_discord_id"))
+
+        updated_at = datetime.datetime.fromisoformat(d.pop("updated_at"))
+
+        operation_response = cls(
+            cancelled_at=cancelled_at,
+            committed_at=committed_at,
+            created_at=created_at,
+            expires_at=expires_at,
+            failed_at=failed_at,
+            guild_id=guild_id,
+            kind=kind,
+            last_error=last_error,
+            operation_id=operation_id,
+            plan=plan,
+            reserved_archive_category_channel_id=reserved_archive_category_channel_id,
+            status=status,
+            subject_discord_id=subject_discord_id,
+            tutor_discord_id=tutor_discord_id,
+            updated_at=updated_at,
+        )
+
+        operation_response.additional_properties = d
+        return operation_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

skillforge_client/models/operation_response_plan.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="OperationResponsePlan")
+
+
+@_attrs_define
+class OperationResponsePlan:
+    """ """
+
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        operation_response_plan = cls()
+
+        operation_response_plan.additional_properties = d
+        return operation_response_plan
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

skillforge_client/models/operation_status.py

@@ -0,0 +1,12 @@
+from enum import Enum
+
+
+class OperationStatus(str, Enum):
+    CANCELLED = "cancelled"
+    COMMITTED = "committed"
+    EXPIRED = "expired"
+    FAILED = "failed"
+    PREPARED = "prepared"
+
+    def __str__(self) -> str:
+        return str(self.value)

skillforge_client/models/operation_summary.py

@@ -0,0 +1,243 @@
+from __future__ import annotations
+
+import datetime
+from collections.abc import Mapping
+from typing import Any, TypeVar, cast
+from uuid import UUID
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.operation_kind import OperationKind
+from ..models.operation_status import OperationStatus
+
+T = TypeVar("T", bound="OperationSummary")
+
+
+@_attrs_define
+class OperationSummary:
+    """List view of an operation. Omits the heavy ``plan`` -- fetch a single operation by id for that.
+
+    Attributes:
+        cancelled_at (datetime.datetime | None):
+        committed_at (datetime.datetime | None):
+        created_at (datetime.datetime):
+        expires_at (datetime.datetime):
+        failed_at (datetime.datetime | None):
+        guild_id (int):
+        kind (OperationKind):
+        last_error (None | str):
+        operation_id (UUID):
+        reserved_archive_category_channel_id (int | None):
+        status (OperationStatus):
+        subject_discord_id (int):
+        tutor_discord_id (int | None):
+        updated_at (datetime.datetime):
+    """
+
+    cancelled_at: datetime.datetime | None
+    committed_at: datetime.datetime | None
+    created_at: datetime.datetime
+    expires_at: datetime.datetime
+    failed_at: datetime.datetime | None
+    guild_id: int
+    kind: OperationKind
+    last_error: None | str
+    operation_id: UUID
+    reserved_archive_category_channel_id: int | None
+    status: OperationStatus
+    subject_discord_id: int
+    tutor_discord_id: int | None
+    updated_at: datetime.datetime
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        cancelled_at: None | str
+        if isinstance(self.cancelled_at, datetime.datetime):
+            cancelled_at = self.cancelled_at.isoformat()
+        else:
+            cancelled_at = self.cancelled_at
+
+        committed_at: None | str
+        if isinstance(self.committed_at, datetime.datetime):
+            committed_at = self.committed_at.isoformat()
+        else:
+            committed_at = self.committed_at
+
+        created_at = self.created_at.isoformat()
+
+        expires_at = self.expires_at.isoformat()
+
+        failed_at: None | str
+        if isinstance(self.failed_at, datetime.datetime):
+            failed_at = self.failed_at.isoformat()
+        else:
+            failed_at = self.failed_at
+
+        guild_id = self.guild_id
+
+        kind = self.kind.value
+
+        last_error: None | str
+        last_error = self.last_error
+
+        operation_id = str(self.operation_id)
+
+        reserved_archive_category_channel_id: int | None
+        reserved_archive_category_channel_id = self.reserved_archive_category_channel_id
+
+        status = self.status.value
+
+        subject_discord_id = self.subject_discord_id
+
+        tutor_discord_id: int | None
+        tutor_discord_id = self.tutor_discord_id
+
+        updated_at = self.updated_at.isoformat()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "cancelled_at": cancelled_at,
+                "committed_at": committed_at,
+                "created_at": created_at,
+                "expires_at": expires_at,
+                "failed_at": failed_at,
+                "guild_id": guild_id,
+                "kind": kind,
+                "last_error": last_error,
+                "operation_id": operation_id,
+                "reserved_archive_category_channel_id": reserved_archive_category_channel_id,
+                "status": status,
+                "subject_discord_id": subject_discord_id,
+                "tutor_discord_id": tutor_discord_id,
+                "updated_at": updated_at,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+
+        def _parse_cancelled_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                cancelled_at_type_0 = datetime.datetime.fromisoformat(data)
+
+                return cancelled_at_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        cancelled_at = _parse_cancelled_at(d.pop("cancelled_at"))
+
+        def _parse_committed_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                committed_at_type_0 = datetime.datetime.fromisoformat(data)
+
+                return committed_at_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        committed_at = _parse_committed_at(d.pop("committed_at"))
+
+        created_at = datetime.datetime.fromisoformat(d.pop("created_at"))
+
+        expires_at = datetime.datetime.fromisoformat(d.pop("expires_at"))
+
+        def _parse_failed_at(data: object) -> datetime.datetime | None:
+            if data is None:
+                return data
+            try:
+                if not isinstance(data, str):
+                    raise TypeError()
+                failed_at_type_0 = datetime.datetime.fromisoformat(data)
+
+                return failed_at_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(datetime.datetime | None, data)
+
+        failed_at = _parse_failed_at(d.pop("failed_at"))
+
+        guild_id = d.pop("guild_id")
+
+        kind = OperationKind(d.pop("kind"))
+
+        def _parse_last_error(data: object) -> None | str:
+            if data is None:
+                return data
+            return cast(None | str, data)
+
+        last_error = _parse_last_error(d.pop("last_error"))
+
+        operation_id = UUID(d.pop("operation_id"))
+
+        def _parse_reserved_archive_category_channel_id(data: object) -> int | None:
+            if data is None:
+                return data
+            return cast(int | None, data)
+
+        reserved_archive_category_channel_id = _parse_reserved_archive_category_channel_id(
+            d.pop("reserved_archive_category_channel_id")
+        )
+
+        status = OperationStatus(d.pop("status"))
+
+        subject_discord_id = d.pop("subject_discord_id")
+
+        def _parse_tutor_discord_id(data: object) -> int | None:
+            if data is None:
+                return data
+            return cast(int | None, data)
+
+        tutor_discord_id = _parse_tutor_discord_id(d.pop("tutor_discord_id"))
+
+        updated_at = datetime.datetime.fromisoformat(d.pop("updated_at"))
+
+        operation_summary = cls(
+            cancelled_at=cancelled_at,
+            committed_at=committed_at,
+            created_at=created_at,
+            expires_at=expires_at,
+            failed_at=failed_at,
+            guild_id=guild_id,
+            kind=kind,
+            last_error=last_error,
+            operation_id=operation_id,
+            reserved_archive_category_channel_id=reserved_archive_category_channel_id,
+            status=status,
+            subject_discord_id=subject_discord_id,
+            tutor_discord_id=tutor_discord_id,
+            updated_at=updated_at,
+        )
+
+        operation_summary.additional_properties = d
+        return operation_summary
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties