diff options
author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-07-16 16:01:58 +0200 |
---|---|---|
committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-07-16 16:01:58 +0200 |
commit | 0be4761961cf145cf66a456d910596aa32912492 (patch) | |
tree | 4a1f7e1f0c0fa54d817cfcc64d82ceeec4771da2 /docs | |
parent | 6f9f42b64cb82929af60e299c70773af6d406a6e (diff) | |
download | gitlab-0be4761961cf145cf66a456d910596aa32912492.tar.gz |
Implement user emails support
Diffstat (limited to 'docs')
-rw-r--r-- | docs/gl_objects/users.py | 44 | ||||
-rw-r--r-- | docs/gl_objects/users.rst | 64 |
2 files changed, 108 insertions, 0 deletions
diff --git a/docs/gl_objects/users.py b/docs/gl_objects/users.py index 99b986f..9b127a4 100644 --- a/docs/gl_objects/users.py +++ b/docs/gl_objects/users.py @@ -64,6 +64,32 @@ user.keys.delete(1) key.delete() # end key delete +# email list +emails = gl.user_emails.list(user_id=1) +# or +emails = user.emails.list() +# end email list + +# email get +email = gl.user_emails.list(1, user_id=1) +# or +email = user.emails.get(1) +# end email get + +# email create +k = gl.user_emails.create({'email': 'foo@bar.com'}, user_id=2) +# or +k = user.emails.create({'email': 'foo@bar.com'}) +# end email create + +# email delete +gl.user_emails.delete(1, user_id=1) +# or +user.emails.delete(1) +# or +email.delete() +# end email delete + # currentuser get gl.auth() current_user = gl.user @@ -86,3 +112,21 @@ gl.user.keys.delete(1) # or key.delete() # end currentuser key delete + +# currentuser email list +emails = gl.user.emails.list() +# end currentuser email list + +# currentuser email get +email = gl.user.emails.get(1) +# end currentuser email get + +# currentuser email create +email = gl.user.emails.create({'email': 'foo@bar.com'}) +# end currentuser email create + +# currentuser email delete +gl.user.emails.delete(1) +# or +email.delete() +# end currentuser email delete diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst index d7a9ab7..8df93b0 100644 --- a/docs/gl_objects/users.rst +++ b/docs/gl_objects/users.rst @@ -88,6 +88,41 @@ Delete an SSH key for a user: :start-after: # key delete :end-before: # end key delete +Emails +====== + +Use the :class:`~gitlab.objects.UserEmail` objects to manage user emails. + +To create :class:`~gitlab.objects.UserEmail` objects use the :attr:`User.emails +<gitlab.objects.User.emails>` or :attr:`gitlab.Gitlab.user_emails` managers. + +Exemples +-------- + +List emails for a user: + +.. literalinclude:: users.py + :start-after: # email list + :end-before: # end email list + +Get an email for a user: + +.. literalinclude:: users.py + :start-after: # email get + :end-before: # end email get + +Create an email for a user: + +.. literalinclude:: users.py + :start-after: # email create + :end-before: # end email create + +Delete an email for a user: + +.. literalinclude:: users.py + :start-after: # email delete + :end-before: # end email delete + Current User ============ @@ -99,6 +134,11 @@ Use the :class:`~gitlab.objects.CurrentUserKey` objects to manage user keys. To create :class:`~gitlab.objects.CurrentUserKey` objects use the :attr:`gitlab.objects.CurrentUser.keys <CurrentUser.keys>` manager. +Use the :class:`~gitlab.objects.CurrentUserEmail` objects to manage user emails. + +To create :class:`~gitlab.objects.CurrentUserEmail` objects use the +:attr:`gitlab.objects.CurrentUser.emails <CurrentUser.emails>` manager. + Examples -------- @@ -131,3 +171,27 @@ Delete a key for the current user: .. literalinclude:: users.py :start-after: # currentuser key delete :end-before: # end currentuser key delete + +List the current user emails: + +.. literalinclude:: users.py + :start-after: # currentuser email list + :end-before: # end currentuser email list + +Get an email for the current user: + +.. literalinclude:: users.py + :start-after: # currentuser email get + :end-before: # end currentuser email get + +Create an email for the current user: + +.. literalinclude:: users.py + :start-after: # currentuser email create + :end-before: # end currentuser email create + +Delete an email for the current user: + +.. literalinclude:: users.py + :start-after: # currentuser email delete + :end-before: # end currentuser email delete |