diff options
| author | 2012-05-27 21:39:03 +0200 | |
|---|---|---|
| committer | 2012-06-03 14:47:23 +0200 | |
| commit | 9dedea7efc93c542d8088435fd45891626bc791b (patch) | |
| tree | fdad343826fd3eeeb9de2fa75f5bf90b085ea92e /pygithub3/services/orgs/members.py | |
| parent | Merge pull request #11 from dsc/patch-1 (diff) | |
| parent | Authors updated (diff) | |
| download | python-github3-9dedea7efc93c542d8088435fd45891626bc791b.tar.xz python-github3-9dedea7efc93c542d8088435fd45891626bc791b.zip | |
Merge #5 'services/orgs'
Diffstat (limited to 'pygithub3/services/orgs/members.py')
| -rw-r--r-- | pygithub3/services/orgs/members.py | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/pygithub3/services/orgs/members.py b/pygithub3/services/orgs/members.py new file mode 100644 index 0000000..fb0da03 --- /dev/null +++ b/pygithub3/services/orgs/members.py @@ -0,0 +1,92 @@ +# -*- encoding: utf-8 -*- + +from . import Service + + +class Members(Service): + """ Consume `Members API <http://developer.github.com/v3/orgs/members/>`_ + """ + + def list(self, org): + """ Get org's members + + :param str org: Organisation name + :returns: A :doc:`result` + + If you call it authenticated, and are a member of the org, public and + private members will be visible. + + If not, only public members will be visible. + """ + request = self.request_builder('orgs.members.list', org=org) + return self._get_result(request) + + def is_member(self, org, user): + """ Determine if user is a member of org + + :param str org: Organisation name + :param str user: User name + """ + request = self.request_builder('orgs.members.is_member', org=org, + user=user) + return self._bool(request) + + def remove_member(self, org, user): + """ Remove user from all teams in org + + :param str org: Organisation name + :param str user: User name + + .. warning :: + You must be authenticated and an owner of org + + """ + request = self.request_builder('orgs.members.delete', org=org, user=user) + return self._delete(request) + + def list_public(self, org): + """ Get org's public members + + :param str org: Organisation name + :returns: A :doc:`result` + """ + request = self.request_builder('orgs.members.listpublic', org=org) + return self._get_result(request) + + def is_public_member(self, org, user): + """ Determine if user is a public member of org + + :param str org: Organisation name + :param str user: User name + """ + request = self.request_builder('orgs.members.is_public_member', + org=org, user=user) + return self._bool(request) + + def publicize_membership(self, org, user): + """ Publicize user's membership in org + + :param str org: Organisation name + :param str user: User name + + .. warning :: + You must be authenticated and the user, or an owner of the org + + """ + request = self.request_builder('orgs.members.publicize', + org=org, user=user) + return self._put(request) + + def conceal_membership(self, org, user): + """ Conceal user's membership in org + + :param str org: Organisation name + :param str user: User name + + .. warning :: + You must be authenticated and the user, or an owner of the org + + """ + request = self.request_builder('orgs.members.conceal', + org=org, user=user) + return self._delete(request) |
