| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Books.Bookshelves.Volumes.List
Description
Retrieves volumes in a specific bookshelf for the specified user.
See: Books API Reference for books.bookshelves.volumes.list.
- type BookshelvesVolumesListResource = "books" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("bookshelves" :> (Capture "shelf" Text :> ("volumes" :> (QueryParam "source" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumes)))))))))))
- bookshelvesVolumesList :: Text -> Text -> BookshelvesVolumesList
- data BookshelvesVolumesList
- bvlUserId :: Lens' BookshelvesVolumesList Text
- bvlShelf :: Lens' BookshelvesVolumesList Text
- bvlSource :: Lens' BookshelvesVolumesList (Maybe Text)
- bvlStartIndex :: Lens' BookshelvesVolumesList (Maybe Word32)
- bvlMaxResults :: Lens' BookshelvesVolumesList (Maybe Word32)
- bvlShowPreOrders :: Lens' BookshelvesVolumesList (Maybe Bool)
REST Resource
type BookshelvesVolumesListResource = "books" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("bookshelves" :> (Capture "shelf" Text :> ("volumes" :> (QueryParam "source" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumes))))))))))) Source
A resource alias for books.bookshelves.volumes.list method which the
BookshelvesVolumesList request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> BookshelvesVolumesList |
Creates a value of BookshelvesVolumesList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data BookshelvesVolumesList Source
Retrieves volumes in a specific bookshelf for the specified user.
See: bookshelvesVolumesList smart constructor.
Request Lenses
bvlUserId :: Lens' BookshelvesVolumesList Text Source
ID of user for whom to retrieve bookshelf volumes.
bvlShelf :: Lens' BookshelvesVolumesList Text Source
ID of bookshelf to retrieve volumes.
bvlSource :: Lens' BookshelvesVolumesList (Maybe Text) Source
String to identify the originator of this request.
bvlStartIndex :: Lens' BookshelvesVolumesList (Maybe Word32) Source
Index of the first element to return (starts at 0)
bvlMaxResults :: Lens' BookshelvesVolumesList (Maybe Word32) Source
Maximum number of results to return
bvlShowPreOrders :: Lens' BookshelvesVolumesList (Maybe Bool) Source
Set to true to show pre-ordered books. Defaults to false.