get_folder_descendants

class sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsRequestPathParams(id: int = REQ)[source]
class sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsRequestQueryParams(depth: int = OPT, limit: int = OPT, cursor: str = OPT, sort: str = OPT)[source]
class sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsRequest(path_params: ~sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsRequestPathParams = <factory>, query_params: ~sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsRequestQueryParams = <factory>, body_params: ~sanhe_confluence_sdk.methods.model.BodyParams = <factory>)[source]

See: https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants/#api-folders-id-descendants-get

class sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsResponseResult(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

Descendant schema - represents a single descendant in the results array.

property id: str

ID of the descendant.

property status: str

ContentStatus enum: current, archived.

property title: str

Title of the descendant.

property type: str

Content type: database, embed, folder, page, or whiteboard.

property parentId: str

ID of the parent content.

property depth: int

Nesting level relative to the requested folder.

property childPosition: int

Ordinal position among siblings in content hierarchy.

class sanhe_confluence_sdk.methods.descendant.get_folder_descendants.GetFolderDescendantsResponse(_raw_data: Dict[str, Any], _http_res: Response | None = None)[source]

DescendantsResponse schema - top level response.