diff options
author | 2012-03-01 13:12:00 +0100 | |
---|---|---|
committer | 2012-03-01 13:12:00 +0100 | |
commit | 397238b404a66ba25aec1e4d7902e16104eddefc (patch) | |
tree | 7453341e1e3257282cf5d87285b451b6fc13ec23 /pygithub3/services/users/emails.py | |
parent | Services.repos.Repo doc (diff) | |
download | python-github3-397238b404a66ba25aec1e4d7902e16104eddefc.tar.xz python-github3-397238b404a66ba25aec1e4d7902e16104eddefc.zip |
Restructure modules and packages in a clean way
The docs has increased lines of code, so I split it
Diffstat (limited to 'pygithub3/services/users/emails.py')
-rw-r--r-- | pygithub3/services/users/emails.py | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/pygithub3/services/users/emails.py b/pygithub3/services/users/emails.py new file mode 100644 index 0000000..084a29c --- /dev/null +++ b/pygithub3/services/users/emails.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Emails(Service): + """ Consume `Emails API <http://developer.github.com/v3/users/emails/>`_ + + .. warning:: + + You must be authenticated for all requests + """ + + def list(self): + """ Get user's emails + + :returns: A :doc:`result` + """ + request = self.make_request('users.emails.list') + return self._get_result(request) + + def add(self, *emails): + """ Add emails + + :param list emails: Emails to add + + .. note:: + + It rejects non-valid emails + + :: + + email_service.add('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.add', body=emails) + return self._post(request) + + def delete(self, *emails): + """ Delete emails + + :param list emails: List of emails + + :: + + email_service.delete('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.delete', body=emails) + self._delete(request) |