aiobearychat.openapi.user_api
¶
用户相关 API.
auto generated by script at 2017-08-24 21:50:13.459796. don’t edit it.
-
class
aiobearychat.openapi.user_api.
UserAPI
(requester: aiobearychat.abc.Requester, token: str, *, base_url: str, **kwargs)[源代码]¶ 用户相关 API.
-
info
(user_id: str, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 返回团队内指定用户完整信息。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/user.info.md
参数: user_id ( str
) – 指定用户 id (示例:=bw52O
)返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "inactive": false, "role": "normal", "email": "support@bearyinnovative.com", "name": "BearyBot", "type": "assistant", "created": "2017-01-11T12:28:31.000+0000", "id": "=bwMkR", "avatars": { "small": null, "medium": null, "large": null }, "team_id": "=bw52O", "full_name": "倍洽小助手", "mobile": null, "profile": { "bio": null, "position": null, "skype": null } }
-
list
(**requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 返回团队内的用户列表,获取某个用户的完整信息,请使用
user.info
.官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/user.list.md
返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: [ { "inactive": false, "role": "normal", "email": "support@bearyinnovative.com", "name": "BearyBot", "type": "assistant", "created": "2017-01-11T12:28:31.000+0000", "id": "=bwMkR", "avatars": { "small": null, "medium": null, "large": null }, "team_id": "=bw52O", "full_name": "倍洽小助手", "mobile": null, "profile": { "bio": null, "position": null, "skype": null } } ]
-
me
(**requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 返回当前用户的信息。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/user.me.md
返回: response. 一个 aiobearychat.sansio.Response
实例返回类型: aiobearychat.sansio.Response
response.body
返回值示例:response.status 等于 200 时: { "inactive": false, "role": "normal", "email": "support@bearyinnovative.com", "name": "BearyBot", "type": "assistant", "created": "2017-01-11T12:28:31.000+0000", "id": "=bwMkR", "avatars": { "small": null, "medium": null, "large": null }, "team_id": "=bw52O", "full_name": "倍洽小助手", "mobile": null, "profile": { "bio": null, "position": null, "skype": null } }
-
update_me
(*, name: str = NOTHING, full_name: str = NOTHING, **requester_params: typing.Any) → aiobearychat.sansio.Response[源代码]¶ 更新当前用户信息。
官方文档地址:https://github.com/bearyinnovative/OpenAPI/blob/master/api/user.update_me.md
参数: - name (
str
) – 用户名 (@name) (示例:beary_bot
) - full_name (
str
) – 用户全名 (示例:BearyBot
)
返回: response. 一个
aiobearychat.sansio.Response
实例返回类型: response.body
返回值示例:response.status 等于 200 时: { "inactive": false, "role": "normal", "email": "support@bearyinnovative.com", "name": "BearyBot", "type": "assistant", "created": "2017-01-11T12:28:31.000+0000", "id": "=bwMkR", "avatars": { "small": null, "medium": null, "large": null }, "team_id": "=bw52O", "full_name": "倍洽小助手", "mobile": null, "profile": { "bio": null, "position": null, "skype": null } }
- name (
-