Source code for sanhe_confluence_sdk.methods.page.get_pages

# -*- coding: utf-8 -*-

import dataclasses
from functools import cached_property

from func_args.api import OPT

from ...client import Confluence

from ..model import api_field, BaseRequest, QueryParams, BaseResponse
from ..common.links import Links


# ------------------------------------------------------------------------------
# Input
# ------------------------------------------------------------------------------


@dataclasses.dataclass(frozen=True)
class GetPagesRequestQueryParams(QueryParams):
    id: list[int] = api_field(OPT)
    space_id: list[int] = api_field(OPT, "space-id")
    sort: str = api_field(OPT)
    status: list[str] = api_field(OPT)
    title: str = api_field(OPT)
    body_format: str = api_field(OPT, "body-format")
    subtype: str = api_field(OPT)
    cursor: str = api_field(OPT)
    limit: int = api_field(OPT)





@dataclasses.dataclass(frozen=True)
class GetPagesRequest(BaseRequest):
    """
    See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-get
    """

    query_params: GetPagesRequestQueryParams = dataclasses.field(
        default_factory=GetPagesRequestQueryParams
    )

    @property
    def _path(self) -> str:
        return "/pages"

    def sync(self, client: Confluence) -> "GetPagesResponse":
        return self._sync_get(GetPagesResponse, client)



# ------------------------------------------------------------------------------
# Output
# ------------------------------------------------------------------------------
# --- Deepest nested objects first ---


@dataclasses.dataclass(frozen=True)
class GetPagesResponseResultBodyStorage(BaseResponse):
    """BodyType schema for storage representation."""

    @cached_property
    def representation(self) -> str:
        return self._get("representation")

    @cached_property
    def value(self) -> str:
        return self._get("value")





@dataclasses.dataclass(frozen=True)
class GetPagesResponseResultBodyAtlasDocFormat(BaseResponse):
    """BodyType schema for atlas_doc_format representation."""

    @cached_property
    def representation(self) -> str:
        return self._get("representation")

    @cached_property
    def value(self) -> str:
        return self._get("value")





@dataclasses.dataclass(frozen=True)
class GetPagesResponseResultBody(BaseResponse):
    """BodyBulk schema - contains fields for each representation type requested."""

    @cached_property
    def storage(self) -> GetPagesResponseResultBodyStorage:
        return self._new(GetPagesResponseResultBodyStorage, "storage")

    @cached_property
    def atlas_doc_format(self) -> GetPagesResponseResultBodyAtlasDocFormat:
        return self._new(GetPagesResponseResultBodyAtlasDocFormat, "atlas_doc_format")





@dataclasses.dataclass(frozen=True)
class GetPagesResponseResultVersion(BaseResponse):
    """Version schema."""

    @cached_property
    def createdAt(self) -> str:
        """Date and time when the version was created. ISO 8601 format."""
        return self._get("createdAt")

    @cached_property
    def message(self) -> str:
        """Message associated with the current version."""
        return self._get("message")

    @cached_property
    def number(self) -> int:
        """The version number."""
        return self._get("number")

    @cached_property
    def minorEdit(self) -> bool:
        """Describes if this version is a minor version."""
        return self._get("minorEdit")

    @cached_property
    def authorId(self) -> str:
        """The account ID of the user who created this version."""
        return self._get("authorId")





@dataclasses.dataclass(frozen=True)
class GetPagesResponseResultLinks(BaseResponse):
    """AbstractPageLinks schema."""

    @cached_property
    def webui(self) -> str:
        """Web UI link of the content."""
        return self._get("webui")

    @cached_property
    def editui(self) -> str:
        """Edit UI link of the content."""
        return self._get("editui")

    @cached_property
    def tinyui(self) -> str:
        """Tiny UI link of the content."""
        return self._get("tinyui")



# --- Main result object ---


@dataclasses.dataclass(frozen=True)
class GetPagesResponseResult(BaseResponse):
    """PageBulk schema - represents a single page in the results array."""

    @cached_property
    def id(self) -> str:
        """ID of the page."""
        return self._get("id")

    @cached_property
    def status(self) -> str:
        """ContentStatus enum: current, draft, archived, historical, trashed, deleted, any."""
        return self._get("status")

    @cached_property
    def title(self) -> str:
        """Title of the page."""
        return self._get("title")

    @cached_property
    def spaceId(self) -> str:
        """ID of the space the page is in."""
        return self._get("spaceId")

    @cached_property
    def parentId(self) -> str:
        """ID of the parent page, or null if there is no parent page."""
        return self._get("parentId")

    @cached_property
    def parentType(self) -> str:
        """ParentContentType enum: page, whiteboard, database, embed, folder."""
        return self._get("parentType")

    @cached_property
    def position(self) -> int:
        """Position of child page within the given parent page tree."""
        return self._get("position")

    @cached_property
    def authorId(self) -> str:
        """The account ID of the user who created this page originally."""
        return self._get("authorId")

    @cached_property
    def ownerId(self) -> str:
        """The account ID of the user who owns this page."""
        return self._get("ownerId")

    @cached_property
    def lastOwnerId(self) -> str:
        """The account ID of the user who owned this page previously, or null."""
        return self._get("lastOwnerId")

    @cached_property
    def subtype(self) -> str:
        """The subtype of the page."""
        return self._get("subtype")

    @cached_property
    def createdAt(self) -> str:
        """Date and time when the page was created. ISO 8601 format."""
        return self._get("createdAt")

    @cached_property
    def version(self) -> GetPagesResponseResultVersion:
        return self._new(GetPagesResponseResultVersion, "version")

    @cached_property
    def body(self) -> GetPagesResponseResultBody:
        return self._new(GetPagesResponseResultBody, "body")

    @cached_property
    def links(self) -> GetPagesResponseResultLinks:
        return self._new(GetPagesResponseResultLinks, "_links")



# --- Top level response objects ---



@dataclasses.dataclass(frozen=True)
class GetPagesResponse(BaseResponse):
    """MultiEntityResult<PageBulk> schema - top level response."""

    @cached_property
    def results(self) -> list[GetPagesResponseResult]:
        return self._new_many(GetPagesResponseResult, "results")

    @cached_property
    def links(self) -> Links:
        return self._new(Links, "_links")