| 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.MyLibrary.Bookshelves.Volumes.List
Description
Gets volume information for volumes on a bookshelf.
See: Books API Reference for books.mylibrary.bookshelves.volumes.list.
- type MyLibraryBookshelvesVolumesListResource = "books" :> ("v1" :> ("mylibrary" :> ("bookshelves" :> (Capture "shelf" Text :> ("volumes" :> (QueryParam "country" Text :> (QueryParam "q" Text :> (QueryParam "source" Text :> (QueryParam "projection" MyLibraryBookshelvesVolumesListProjection :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumes)))))))))))))
- myLibraryBookshelvesVolumesList :: Text -> MyLibraryBookshelvesVolumesList
- data MyLibraryBookshelvesVolumesList
- mlbvlCountry :: Lens' MyLibraryBookshelvesVolumesList (Maybe Text)
- mlbvlQ :: Lens' MyLibraryBookshelvesVolumesList (Maybe Text)
- mlbvlShelf :: Lens' MyLibraryBookshelvesVolumesList Text
- mlbvlSource :: Lens' MyLibraryBookshelvesVolumesList (Maybe Text)
- mlbvlProjection :: Lens' MyLibraryBookshelvesVolumesList (Maybe MyLibraryBookshelvesVolumesListProjection)
- mlbvlStartIndex :: Lens' MyLibraryBookshelvesVolumesList (Maybe Word32)
- mlbvlMaxResults :: Lens' MyLibraryBookshelvesVolumesList (Maybe Word32)
- mlbvlShowPreOrders :: Lens' MyLibraryBookshelvesVolumesList (Maybe Bool)
REST Resource
type MyLibraryBookshelvesVolumesListResource = "books" :> ("v1" :> ("mylibrary" :> ("bookshelves" :> (Capture "shelf" Text :> ("volumes" :> (QueryParam "country" Text :> (QueryParam "q" Text :> (QueryParam "source" Text :> (QueryParam "projection" MyLibraryBookshelvesVolumesListProjection :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumes))))))))))))) Source
A resource alias for books.mylibrary.bookshelves.volumes.list method which the
MyLibraryBookshelvesVolumesList request conforms to.
Creating a Request
myLibraryBookshelvesVolumesList Source
Arguments
| :: Text | |
| -> MyLibraryBookshelvesVolumesList |
Creates a value of MyLibraryBookshelvesVolumesList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data MyLibraryBookshelvesVolumesList Source
Gets volume information for volumes on a bookshelf.
See: myLibraryBookshelvesVolumesList smart constructor.
Instances
Request Lenses
mlbvlCountry :: Lens' MyLibraryBookshelvesVolumesList (Maybe Text) Source
ISO-3166-1 code to override the IP-based location.
mlbvlQ :: Lens' MyLibraryBookshelvesVolumesList (Maybe Text) Source
Full-text search query string in this bookshelf.
mlbvlShelf :: Lens' MyLibraryBookshelvesVolumesList Text Source
The bookshelf ID or name retrieve volumes for.
mlbvlSource :: Lens' MyLibraryBookshelvesVolumesList (Maybe Text) Source
String to identify the originator of this request.
mlbvlProjection :: Lens' MyLibraryBookshelvesVolumesList (Maybe MyLibraryBookshelvesVolumesListProjection) Source
Restrict information returned to a set of selected fields.
mlbvlStartIndex :: Lens' MyLibraryBookshelvesVolumesList (Maybe Word32) Source
Index of the first element to return (starts at 0)
mlbvlMaxResults :: Lens' MyLibraryBookshelvesVolumesList (Maybe Word32) Source
Maximum number of results to return
mlbvlShowPreOrders :: Lens' MyLibraryBookshelvesVolumesList (Maybe Bool) Source
Set to true to show pre-ordered books. Defaults to false.