definitions

feishu.approval.definitions

DefinitionsNamespace

Bases: Namespace

审批定义接口命名空间。

通过 client.approval.definitions 访问，封装飞书审批中审批定义（approval）相关的服务端接口。 审批定义以 approval_code 标识，描述一类审批的表单结构、节点流程与状态等元信息。

通常无需直接实例化，应通过 client.approval.definitions 访问。

飞书文档

审批 / 审批定义

源代码位于： feishu/approval/definitions.py

class DefinitionsNamespace(Namespace):
    r"""
    审批定义接口命名空间。

    通过 `client.approval.definitions` 访问，封装飞书审批中审批定义（approval）相关的服务端接口。
    审批定义以 `approval_code` 标识，描述一类审批的表单结构、节点流程与状态等元信息。

    通常无需直接实例化，应通过 `client.approval.definitions` 访问。

    飞书文档:
        [审批 / 审批定义](https://open.feishu.cn/document/server-docs/approval-v4/approval/get)
    """

    async def list(
        self,
        *,
        page_size: int = 50,
        max_items: int | None = None,
        locale: str | None = None,
    ) -> list[NestedDict]:
        r"""
        查询当前身份可发起的审批定义列表。

        飞书按调用身份过滤可发起的审批定义；该接口通常需要通过
        [feishu.client.FeishuClient.as_user][] 派生的用户视图调用。

        Args:
            page_size: 每页条数，超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。
            max_items: 最多返回的条数；为空表示返回全部。
            locale: 国际化语言，如 `zh-CN`、`en-US`；为空时省略该参数。

        Returns:
            审批定义摘要列表，每项通常包含 `approval_code` 与 `approval_name`。

        飞书文档:
            [查询审批定义列表](https://feishu.apifox.cn/api-59181909)
        """
        params = {}
        if locale is not None:
            params["locale"] = locale
        items = await self._client.paginate_get(
            "approval/v4/approvals",
            params=params,
            page_size=min(page_size, MAX_PAGE_SIZE),
            max_items=max_items,
        )
        return [NestedDict(item) for item in items if isinstance(item, dict)]

    async def get(self, approval_code: str, *, locale: str | None = None, user_id: str | None = None) -> NestedDict:
        r"""
        查询审批定义。

        获取指定审批定义的详情。仅将显式传入的可选查询参数并入请求，未设置的项会被省略。

        Args:
            approval_code: 审批定义的唯一标识 `approval_code`。
            locale: 国际化语言，如 `zh-CN`、`en-US`；为空时省略该参数。
            user_id: 用户 ID，用于按指定用户视角返回审批定义；为空时省略该参数。

        Returns:
            审批定义数据，含 `approval_name`、`form`、`node_list`、`status` 等字段。

        Raises:
            feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

        飞书文档:
            [查看指定审批定义](https://open.feishu.cn/document/server-docs/approval-v4/approval/get)

        Examples:
            >>> await client.approval.definitions.get("ABC123")  # doctest:+SKIP
            {'approval_name': '请假', 'form': '...', 'node_list': [...], ...}  # noqa: E501
        """
        params = {}
        if locale is not None:
            params["locale"] = locale
        if user_id is not None:
            params["user_id"] = user_id
        return await self._request_data("GET", f"approval/v4/approvals/{quote_segment(approval_code)}", params=params)

list async

Python

list(*, page_size: int = 50, max_items: int | None = None, locale: str | None = None) -> list[NestedDict]

查询当前身份可发起的审批定义列表。

飞书按调用身份过滤可发起的审批定义；该接口通常需要通过 feishu.client.FeishuClient.as_user 派生的用户视图调用。

参数：

名称	类型	描述	默认
page_size	int	每页条数，超过 feishu.consts.MAX_PAGE_SIZE 时由客户端收敛。	50
max_items	int | None	最多返回的条数；为空表示返回全部。	None
locale	str | None	国际化语言，如 zh-CN、en-US；为空时省略该参数。	None

返回：

类型	描述
list[NestedDict]	审批定义摘要列表，每项通常包含 approval_code 与 approval_name。

飞书文档

查询审批定义列表

源代码位于： feishu/approval/definitions.py

async def list(
    self,
    *,
    page_size: int = 50,
    max_items: int | None = None,
    locale: str | None = None,
) -> list[NestedDict]:
    r"""
    查询当前身份可发起的审批定义列表。

    飞书按调用身份过滤可发起的审批定义；该接口通常需要通过
    [feishu.client.FeishuClient.as_user][] 派生的用户视图调用。

    Args:
        page_size: 每页条数，超过 [feishu.consts.MAX_PAGE_SIZE][] 时由客户端收敛。
        max_items: 最多返回的条数；为空表示返回全部。
        locale: 国际化语言，如 `zh-CN`、`en-US`；为空时省略该参数。

    Returns:
        审批定义摘要列表，每项通常包含 `approval_code` 与 `approval_name`。

    飞书文档:
        [查询审批定义列表](https://feishu.apifox.cn/api-59181909)
    """
    params = {}
    if locale is not None:
        params["locale"] = locale
    items = await self._client.paginate_get(
        "approval/v4/approvals",
        params=params,
        page_size=min(page_size, MAX_PAGE_SIZE),
        max_items=max_items,
    )
    return [NestedDict(item) for item in items if isinstance(item, dict)]

get async

Python

get(approval_code: str, *, locale: str | None = None, user_id: str | None = None) -> NestedDict

查询审批定义。

获取指定审批定义的详情。仅将显式传入的可选查询参数并入请求，未设置的项会被省略。

参数：

名称	类型	描述	默认
approval_code	str	审批定义的唯一标识 approval_code。	必需
locale	str | None	国际化语言，如 zh-CN、en-US；为空时省略该参数。	None
user_id	str | None	用户 ID，用于按指定用户视角返回审批定义；为空时省略该参数。	None

返回：

类型	描述
NestedDict	审批定义数据，含 approval_name、form、node_list、status 等字段。

引发：

类型	描述
FeishuError	请求失败或返回错误码时抛出。

飞书文档

查看指定审批定义

示例：

>>> await client.approval.definitions.get("ABC123")
{'approval_name': '请假', 'form': '...', 'node_list': [...], ...}  # noqa: E501

源代码位于： feishu/approval/definitions.py

async def get(self, approval_code: str, *, locale: str | None = None, user_id: str | None = None) -> NestedDict:
    r"""
    查询审批定义。

    获取指定审批定义的详情。仅将显式传入的可选查询参数并入请求，未设置的项会被省略。

    Args:
        approval_code: 审批定义的唯一标识 `approval_code`。
        locale: 国际化语言，如 `zh-CN`、`en-US`；为空时省略该参数。
        user_id: 用户 ID，用于按指定用户视角返回审批定义；为空时省略该参数。

    Returns:
        审批定义数据，含 `approval_name`、`form`、`node_list`、`status` 等字段。

    Raises:
        feishu.errors.FeishuError: 请求失败或返回错误码时抛出。

    飞书文档:
        [查看指定审批定义](https://open.feishu.cn/document/server-docs/approval-v4/approval/get)

    Examples:
        >>> await client.approval.definitions.get("ABC123")  # doctest:+SKIP
        {'approval_name': '请假', 'form': '...', 'node_list': [...], ...}  # noqa: E501
    """
    params = {}
    if locale is not None:
        params["locale"] = locale
    if user_id is not None:
        params["user_id"] = user_id
    return await self._request_data("GET", f"approval/v4/approvals/{quote_segment(approval_code)}", params=params)