Module: NatureRemo::Endpoints::Users

Included in:

NatureRemo::Endpoints

Defined in:

lib/nature_remo/endpoints/users.rb

Overview

Endpoints for user infomation

Instance Method Summary

• #update_user_me(nickname:) ⇒ String

  Update authenticated user nickname.

• #user_me ⇒ String

  Fetch the authenticated user’s information.

Instance Method Details

#update_user_me(nickname:) ⇒ String

Update authenticated user nickname. swagger.nature.global/#/default/post_1_users_me

Parameters:

• nickname (String) —

  New user’s nickname.

Returns:

• (String) —

  Updated user information.

Raises:

• (NatureRemo::ServerError) —

  Raise error if resposonse status is NOT success.

# File 'lib/nature_remo/endpoints/users.rb', line 22

def update_user_me(nickname:)
  post('users/me', { nickname: nickname })
end

#user_me ⇒ String

Fetch the authenticated user’s information. swagger.nature.global/#/default/get_1_users_me

Returns:

• (String) —

  User information.

Raises:

• (NatureRemo::ServerError) —

  Raise error if resposonse status is NOT success.

# File 'lib/nature_remo/endpoints/users.rb', line 12

def user_me
  get('users/me')
end