Module: Imgur::Request::Album

Included in:

Client

Defined in:

(ruby-imgur 0.0.1) ruby-imgur/client_request.rb

Overview

Note:

Everything about album stated in this doc will use id instead of album_hash to maintain consistency with “id” related queries.

Instance Method Summary

• #add_album_images(body = nil, id:) ⇒ Response::Base

  Response data from /album/:id/add.

• #create_album(body = nil) ⇒ Response::Base

  Response data from /album.

• #delete_album(body = nil, id:) ⇒ Response::Base

  Response data from /album/:id.

• #do_album_favorite(body = nil, id:) ⇒ Response::Base

  Response data from /album/:id/favorite.

• #get_album(body = nil, id:) ⇒ Response::Base<Model::Album>

  Response data from /album/:id.

• #get_album_image(body = nil, id:, image_id:) ⇒ Response::Base<Model::Image>

  Response data from /album/:id/image/:image_id.

• #get_album_images(body = nil, id:) ⇒ Response::Base<Array<Model::Image>>

  Response data from /album/:id/images.

• #remove_album_images(body = nil, id:) ⇒ Response::Base

  Response data from /album/:id/remove_images.

• #set_album_images(body = nil, id:) ⇒ Response::Base

  Response data from /album/:id.

• #update_album(body = nil, id:) ⇒ Response::Base

  Response data from /album/:id.

Instance Method Details

#add_album_images(body = nil, id:) ⇒ Response::Base

Returns response data from /album/:id/add.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id/add

Returns:

• (Response::Base) —

  response data from /album/:id/add

#create_album(body = nil) ⇒ Response::Base

Returns response data from /album.

Parameters:

• data (Hash) —

  additional keys accepted for /album

Returns:

• (Response::Base) —

  response data from /album

#delete_album(body = nil, id:) ⇒ Response::Base

Returns response data from /album/:id.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id

Returns:

• (Response::Base) —

  response data from /album/:id

#do_album_favorite(body = nil, id:) ⇒ Response::Base

Returns response data from /album/:id/favorite.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id/favorite

Returns:

• (Response::Base) —

  response data from /album/:id/favorite

#get_album(body = nil, id:) ⇒ Response::Base<Model::Album>

Returns response data from /album/:id.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id

Returns:

• (Response::Base<Model::Album>) —

  response data from /album/:id

#get_album_image(body = nil, id:, image_id:) ⇒ Response::Base<Model::Image>

Returns response data from /album/:id/image/:image_id.

Parameters:

• id (String) —

  Required

• image_id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id/image/:image_id

Returns:

• (Response::Base<Model::Image>) —

  response data from /album/:id/image/:image_id

#get_album_images(body = nil, id:) ⇒ Response::Base<Array<Model::Image>>

Returns response data from /album/:id/images.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id/images

Returns:

• (Response::Base<Array<Model::Image>>) —

  response data from /album/:id/images

#remove_album_images(body = nil, id:) ⇒ Response::Base

Returns response data from /album/:id/remove_images.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id/remove_images

Returns:

• (Response::Base) —

  response data from /album/:id/remove_images

#set_album_images(body = nil, id:) ⇒ Response::Base

Returns response data from /album/:id.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id

Returns:

• (Response::Base) —

  response data from /album/:id

#update_album(body = nil, id:) ⇒ Response::Base

Returns response data from /album/:id.

Parameters:

• id (String) —

  Required

• data (Hash) —

  additional keys accepted for /album/:id

Returns:

• (Response::Base) —

  response data from /album/:id