manyi/venv/Lib/site-packages/wechatpy/enterprise/client/api/department.py

# -*- coding: utf-8 -*-
from __future__ import absolute_import, unicode_literals

from itertools import chain
from optionaldict import optionaldict

from wechatpy.client.api.base import BaseWeChatAPI


class WeChatDepartment(BaseWeChatAPI):
    """
    https://work.weixin.qq.com/api/doc#90000/90135/90204
    """

    def create(self, name, parent_id=1, order=None, id=None):
        """
        创建部门

        https://work.weixin.qq.com/api/doc#90000/90135/90205

        :param name: 部门名称。长度限制为1~32个字符，字符不能包括\\:?”<>｜
        :param parent_id: 父部门id，32位整型
        :param order: 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
        :param id: 部门id，32位整型，指定时必须大于1。若不填该参数，将自动生成id
        :return: 返回的 JSON 数据包
        """
        data = optionaldict(
            name=name,
            parentid=parent_id,
            order=order,
            id=id
        )
        return self._post('department/create', data=data)

    def update(self, id, name=None, parent_id=None, order=None):
        """
        更新部门

        https://work.weixin.qq.com/api/doc#90000/90135/90206

        :param id: 部门 id
        :param name: 部门名称。长度限制为1~32个字符，字符不能包括\\:?”<>｜
        :param parent_id: 父亲部门id
        :param order: 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
        :return: 返回的 JSON 数据包
        """
        data = optionaldict(
            id=id,
            name=name,
            parentid=parent_id,
            order=order
        )
        return self._post('department/update', data=data)

    def delete(self, id):
        """
        删除部门

        https://work.weixin.qq.com/api/doc#90000/90135/90207

        :param id: 部门id。（注：不能删除根部门；不能删除含有子部门、成员的部门）
        :return: 返回的 JSON 数据包
        """
        return self._get('department/delete', params={'id': id})

    def get(self, id=None):
        """
        获取指定部门列表

        https://work.weixin.qq.com/api/doc#90000/90135/90208

        权限说明：
        只能拉取token对应的应用的权限范围内的部门列表

        :param id: 部门id。获取指定部门及其下的子部门。 如果不填，默认获取全量组织架构
        :return: 部门列表
        """
        if id is None:
            res = self._get('department/list')
        else:
            res = self._get('department/list', params={'id': id})
        return res['department']

    def get_users(self, id, status=0, fetch_child=0, simple=True):
        """
        获取部门成员：https://work.weixin.qq.com/api/doc#90000/90135/90200

        获取部门成员详情：https://work.weixin.qq.com/api/doc#90000/90135/90201

        :param id: 部门 id
        :param status: 0 获取全部员工，1 获取已关注成员列表，
                       2 获取禁用成员列表，4 获取未关注成员列表。可叠加
        :param fetch_child: 1/0：是否递归获取子部门下面的成员
        :param simple: True 获取部门成员，False 获取部门成员详情
        :return: 部门成员列表
        """
        url = 'user/simplelist' if simple else 'user/list'
        res = self._get(
            url,
            params={
                'department_id': id,
                'status': status,
                'fetch_child': 1 if fetch_child else 0
            }
        )
        return res['userlist']

    def get_map_users(self, id=None, key='name', status=0, fetch_child=0):
        """
        映射员工某详细字段到 ``user_id``

        企业微信许多对员工操作依赖于 ``user_id`` ，但没有提供直接查询员工对应 ``user_id`` 的结构，

        这里是一个变通的方法，常用于储存员工 ``user_id`` ，并用于后续查询或对单人操作（如发送指定消息）

        :param id: 部门 id， 如果不填，默认获取有权限的所有部门
        :param key: 员工详细信息字段 key，所指向的值必须唯一
        :param status: 0 获取全部员工，1 获取已关注成员列表，
                       2 获取禁用成员列表，4 获取未关注成员列表。可叠加
        :param fetch_child: 1/0：是否递归获取子部门下面的成员
        :return: dict - 部门成员指定字段到 user_id 的 map  ``{ key: user_id }``
        """
        ids = [id] if id is None else [item['id'] for item in self.get()]
        users_info = list(chain(*[
            self.get_users(department, status=status, fetch_child=fetch_child, simple=False)
            for department in ids
        ]))
        users_zip = [(user[key], user['userid']) for user in users_info]
        return dict(users_zip)