user_methods.rb in pixela-0.1.1

- old
+ new

@@ -4,10 +4,12 @@
   # @param agree_terms_of_service [Boolean]
   # @param not_minor [Boolean]
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-user
   def create_user(agree_terms_of_service:, not_minor:)
     params = {
       token:               token,
       username:            username,
@@ -24,10 +26,12 @@
   #
   # @param new_token [String]
   #
   # @return [Hashie::Mash]
   #
+  # @raise [Pixela::PixelaError] API is failed
+  #
   # @see https://pixe.la/#api-user
   def update_user(new_token:)
     params = {
       newToken: new_token,
     }
@@ -43,9 +47,11 @@
   end
 
   # Deletes the specified registered user.
   #
   # @return [Hashie::Mash]
+  #
+  # @raise [Pixela::PixelaError] API is failed
   #
   # @see https://pixe.la/#api-user
   def delete_user
     with_error_handling do
       connection.delete("users/#{username}", nil, user_token_headers).body