Module: Croudia::API::Account

Included in:

Client

Defined in:

lib/croudia/api/account.rb

Instance Method Summary

• #update_cover_image(image, params = {}) ⇒ Croudia::User

  Update cover image.

• #update_profile(params) ⇒ Croudia::User

  Update profile.

• #update_profile_image(image, params = {}) ⇒ Croudia::User

  Update profile image.

• #verify_credentials(params = {}) ⇒ Croudia::User (also: #current_user)

  Retrieve the Authenticated User.

Instance Method Details

#update_cover_image(image, params = {}) ⇒ Croudia::User #update_cover_image(params = {}) ⇒ Croudia::User

Update cover image

Overloads:

• #update_cover_image(image, params = {}) ⇒ Croudia::User

  Parameters:

  • image (File) —

    New cover image

  • params (Hash) (defaults to: {}) —

    Addtional query parameters

• #update_cover_image(params = {}) ⇒ Croudia::User

  Parameters:

  • params (Hash) (defaults to: {}) —

    Query parameters

  Options Hash (params):

  • :image (File) —

    New cover image

Returns:

• (Croudia::User) —

  Current user’s object updated

See Also:

• https://developer.croudia.com/docs/39_account_update_cover_image

# File 'lib/croudia/api/account.rb', line 43

def update_cover_image(image, params={})
  merge_file!(params, image, :image)
  resp = post('/account/update_cover_image.json', params)
  Croudia::User.new(resp)
end

#update_profile(params) ⇒ Croudia::User

Update profile

Parameters:

• params (Hash) —

  Additional query parameters

Options Hash (params):

• :description (String) —

  Bio of the user

• :location (String) —

  Geo location

• :name (String) —

  Name of the user

• :url (String) —

  URL

Returns:

• (Croudia::User) —

  Updated profile

See Also:

• https://developer.croudia.com/docs/37_account_update_profile

# File 'lib/croudia/api/account.rb', line 58

def update_profile(params)
  resp = post('/account/update_profile.json', params)
  Croudia::User.new(resp)
end

#update_profile_image(image, params = {}) ⇒ Croudia::User #update_profile_image(params = {}) ⇒ Croudia::User

Update profile image

Overloads:

• #update_profile_image(image, params = {}) ⇒ Croudia::User

  Parameters:

  • image (File) —

    New profile image

  • params (Hash) (defaults to: {}) —

    Addtional query parameters

• #update_profile_image(params = {}) ⇒ Croudia::User

  Parameters:

  • params (Hash) (defaults to: {}) —

    Query parameters

  Options Hash (params):

  • :image (File) —

    New profile image

Returns:

• (Croudia::User) —

  Current user’s object updated

See Also:

• https://developer.croudia.com/docs/36_account_update_profile_image

# File 'lib/croudia/api/account.rb', line 27

def update_profile_image(image, params={})
  merge_file!(params, image, :image)
  resp = post('/account/update_profile_image.json', params)
  Croudia::User.new(resp)
end

#verify_credentials(params = {}) ⇒ Croudia::User Also known as: current_user

Retrieve the Authenticated User

Parameters:

• params (Hash) (defaults to: {}) —

  Additional query parameterss

Returns:

• (Croudia::User) —

  Current user’s object

See Also:

• https://developer.croudia.com/docs/35_account_verify_credentials

# File 'lib/croudia/api/account.rb', line 11

def verify_credentials(params={})
  resp = get('/account/verify_credentials.json', params)
  Croudia::User.new(resp)
end