组织接口¶
-
class
teambition.api.organizations.
Organizations
(client=None)[源代码]¶ -
add_members
(id, email)[源代码]¶ 添加组织成员
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-add-member
参数: - id – 组织 ID
- email – 邮箱或邮箱列表
返回: 返回的 JSON 数据包
-
create
(name, description=None, logo=None, location=None, website=None)[源代码]¶ 创建新组织
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-create
参数: - name – 组织名字
- description – 可选,描述
- logo – 可选,组织 logo
- location – 可选,组织所在地
- website – 可选,组织网站
返回: 返回的 JSON 数据包
-
create_members
(id, email)¶ 添加组织成员
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-add-member
参数: - id – 组织 ID
- email – 邮箱或邮箱列表
返回: 返回的 JSON 数据包
-
create_webhook
(id, callback_url, active=True, events=None)[源代码]¶ 新建组织 webhook
参数: - id – 组织 ID
- callback_url – 回调地址,Teambition通过HEAD请求进行测试, 有事件被触发将发送POST请求
- active – 可选,是否激活,默认为 True
- events – 可选,事件列表,默认为空
返回: 返回的 JSON 数据包
-
delete
(id)[源代码]¶ 删除组织
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-delete
参数: id – 组织 ID 返回: 返回的 JSON 数据包
-
get
(id=None)[源代码]¶ 获取组织信息
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-get
参数: id – 可选,组织 ID 返回: 提供 id 返回特定组织信息,否则返回用户相关组织列表
-
get_member_events
(id, member_id, start_date=None)[源代码]¶ 获取组织成员日程
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-get-member-events
参数: - id – 组织 ID
- member_id – 成员 ID
- start_date – 可选,起始日期,默认为当周的起始日期
返回: 返回的 JSON 数据包
-
get_member_tasks
(id, member_id, start_date=None, is_done=None, all=False, page=1, count=30)[源代码]¶ 获取组织成员任务
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-get-member-tasks
参数: - id – 组织 ID
- member_id – 成员 ID
- start_date – 可选,起始日期,默认为当周的起始日期
- is_done – 可选,是否完成,默认为 False
- all – 可选,是否返回所有
- page – 可选,页码
- count – 可选,每页数量,默认为 30
返回: 返回的 JSON 数据包
-
get_members
(id, user_id=None)[源代码]¶ 获取组织成员
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-get-member
参数: - id – 组织 ID
- user_id – 可选,成员 ID
返回: 返回的 JSON 数据包
-
get_projects
(id, project_id=None, is_archived=False)[源代码]¶ 获取组织项目
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-projects
参数: - id – 组织 ID
- project_id – 可选,项目 ID
- is_archived – 可选,是否归档,默认为 False
返回: 返回的 JSON 数据包
-
get_recommend_members
(id)[源代码]¶ 获取组织推荐成员列表
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-recommend-members
参数: id – 组织 ID 返回: 返回的 JSON 数据包
-
get_statistic
(id, base=u'member', start_date=None, end_date=None)[源代码]¶ 获取组织统计数据
详情请参参考 http://docs.teambition.com/wiki/orgs#orgs-statistic
参数: - id – 组织 ID
- base – 可选,统计基于对象,可选值为 member, team, project,默认为 member
- start_date – 可选,开始日期,默认为一个月前
- end_date – 可选,结束日期,默认为今天
返回: 返回的 JSON 数据包
-
quit
(id)[源代码]¶ 退出组织
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-quit
参数: id – 组织 ID 返回: 返回的 JSON 数据包
-
remove_member
(id, user_id)[源代码]¶ 删除组织成员
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-remove-member
参数: - id – 组织 ID
- user_id – 成员 ID
返回: 返回的 JSON 数据包
-
resend_invitation
(id, user_id)[源代码]¶ 重发邀请邮件
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-resend-invitation
参数: - id – 组织 ID
- user_id – 成员 ID
返回: 返回的 JSON 数据包
-
update
(id, name=None, description=None, logo=None, location=None, website=None)[源代码]¶ 更新组织信息
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-update
参数: - id – 组织 ID
- name – 组织名字
- description – 可选,描述
- logo – 可选,组织 logo
- location – 可选,组织所在地
- website – 可选,组织网站
返回: 返回的 JSON 数据包
-
update_dividers
(id, dividers)[源代码]¶ 更新组织项目分组
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-dividers
参数: - id – 组织 ID
- dividers – 分组列表
返回: 返回的 JSON 数据包
-
update_member_role
(id, user_id, role_type)[源代码]¶ 更新组织成员角色
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-update-member
参数: - id – 组织 ID
- user_id – 组织成员 ID
- role_type – 角色类型, 可选值 member, admin, owner
-
update_projects
(id, project_ids)[源代码]¶ 更新组织内项目顺序
详情请参考 http://docs.teambition.com/wiki/orgs#orgs-update_projectids
参数: - id – 组织 ID
- project_ids – 项目 id 列表
返回: 返回的 JSON 数据包
-
update_webhook
(id, hook_id, callback_url=None, active=True, events=None, add_events=None, remove_events=None)[源代码]¶ 更新组织 webhook
参数: - id – 组织 ID
- hook_id – webhook ID
- callback_url – 可选,回调地址,Teambition通过HEAD请求进行测试, 有事件被触发将发送POST请求
- active – 可选,是否激活,默认为 True
- events – 可选,事件列表,默认为空
- add_events – 可选,追加新的事件进去
- remove_events – 可选,从原有的事件列表中移除
返回: 返回的 JSON 数据包
-