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 |
Performs a book search.
See: Books API Reference for books.volumes.list
.
- type VolumesListResource = "books" :> ("v1" :> ("volumes" :> (QueryParam "q" Text :> (QueryParam "orderBy" VolumesListOrderBy :> (QueryParam "libraryRestrict" VolumesListLibraryRestrict :> (QueryParam "partner" Text :> (QueryParam "download" VolumesListDownload :> (QueryParam "source" Text :> (QueryParam "projection" VolumesListProjection :> (QueryParam "filter" VolumesListFilter :> (QueryParam "langRestrict" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "printType" VolumesListPrintType :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumes))))))))))))))))
- volumesList :: Text -> VolumesList
- data VolumesList
- vlOrderBy :: Lens' VolumesList (Maybe VolumesListOrderBy)
- vlLibraryRestrict :: Lens' VolumesList (Maybe VolumesListLibraryRestrict)
- vlPartner :: Lens' VolumesList (Maybe Text)
- vlQ :: Lens' VolumesList Text
- vlDownload :: Lens' VolumesList (Maybe VolumesListDownload)
- vlSource :: Lens' VolumesList (Maybe Text)
- vlProjection :: Lens' VolumesList (Maybe VolumesListProjection)
- vlFilter :: Lens' VolumesList (Maybe VolumesListFilter)
- vlLangRestrict :: Lens' VolumesList (Maybe Text)
- vlStartIndex :: Lens' VolumesList (Maybe Word32)
- vlMaxResults :: Lens' VolumesList (Maybe Word32)
- vlShowPreOrders :: Lens' VolumesList (Maybe Bool)
- vlPrintType :: Lens' VolumesList (Maybe VolumesListPrintType)
REST Resource
type VolumesListResource = "books" :> ("v1" :> ("volumes" :> (QueryParam "q" Text :> (QueryParam "orderBy" VolumesListOrderBy :> (QueryParam "libraryRestrict" VolumesListLibraryRestrict :> (QueryParam "partner" Text :> (QueryParam "download" VolumesListDownload :> (QueryParam "source" Text :> (QueryParam "projection" VolumesListProjection :> (QueryParam "filter" VolumesListFilter :> (QueryParam "langRestrict" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "printType" VolumesListPrintType :> (QueryParam "alt" AltJSON :> Get `[JSON]` Volumes)))))))))))))))) Source
A resource alias for books.volumes.list
method which the
VolumesList
request conforms to.
Creating a Request
:: Text | |
-> VolumesList |
Creates a value of VolumesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data VolumesList Source
Performs a book search.
See: volumesList
smart constructor.
Request Lenses
vlOrderBy :: Lens' VolumesList (Maybe VolumesListOrderBy) Source
Sort search results.
vlLibraryRestrict :: Lens' VolumesList (Maybe VolumesListLibraryRestrict) Source
Restrict search to this user's library.
vlQ :: Lens' VolumesList Text Source
Full-text search query string.
vlDownload :: Lens' VolumesList (Maybe VolumesListDownload) Source
Restrict to volumes by download availability.
vlProjection :: Lens' VolumesList (Maybe VolumesListProjection) Source
Restrict information returned to a set of selected fields.
vlFilter :: Lens' VolumesList (Maybe VolumesListFilter) Source
Filter search results.
vlLangRestrict :: Lens' VolumesList (Maybe Text) Source
Restrict results to books with this language code.
vlStartIndex :: Lens' VolumesList (Maybe Word32) Source
Index of the first result to return (starts at 0)
vlMaxResults :: Lens' VolumesList (Maybe Word32) Source
Maximum number of results to return.
vlShowPreOrders :: Lens' VolumesList (Maybe Bool) Source
Set to true to show books available for preorder. Defaults to false.
vlPrintType :: Lens' VolumesList (Maybe VolumesListPrintType) Source
Restrict to books or magazines.