Copyright | (c) 2015-2016 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 |
Gets volume information for a single volume.
See: Books API Reference for books.volumes.get
.
Synopsis
- type VolumesGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> (QueryParam "country" Text :> (QueryParam "includeNonComicsSeries" Bool :> (QueryParam "partner" Text :> (QueryParam "source" Text :> (QueryParam "projection" VolumesGetProjection :> (QueryParam "user_library_consistent_read" Bool :> (QueryParam "alt" AltJSON :> Get '[JSON] Volume))))))))))
- volumesGet :: Text -> VolumesGet
- data VolumesGet
- vgCountry :: Lens' VolumesGet (Maybe Text)
- vgIncludeNonComicsSeries :: Lens' VolumesGet (Maybe Bool)
- vgPartner :: Lens' VolumesGet (Maybe Text)
- vgVolumeId :: Lens' VolumesGet Text
- vgSource :: Lens' VolumesGet (Maybe Text)
- vgProjection :: Lens' VolumesGet (Maybe VolumesGetProjection)
- vgUserLibraryConsistentRead :: Lens' VolumesGet (Maybe Bool)
REST Resource
type VolumesGetResource = "books" :> ("v1" :> ("volumes" :> (Capture "volumeId" Text :> (QueryParam "country" Text :> (QueryParam "includeNonComicsSeries" Bool :> (QueryParam "partner" Text :> (QueryParam "source" Text :> (QueryParam "projection" VolumesGetProjection :> (QueryParam "user_library_consistent_read" Bool :> (QueryParam "alt" AltJSON :> Get '[JSON] Volume)))))))))) Source #
A resource alias for books.volumes.get
method which the
VolumesGet
request conforms to.
Creating a Request
:: Text | |
-> VolumesGet |
Creates a value of VolumesGet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data VolumesGet Source #
Gets volume information for a single volume.
See: volumesGet
smart constructor.
Instances
Request Lenses
vgCountry :: Lens' VolumesGet (Maybe Text) Source #
ISO-3166-1 code to override the IP-based location.
vgIncludeNonComicsSeries :: Lens' VolumesGet (Maybe Bool) Source #
Set to true to include non-comics series. Defaults to false.
vgVolumeId :: Lens' VolumesGet Text Source #
ID of volume to retrieve.
vgSource :: Lens' VolumesGet (Maybe Text) Source #
String to identify the originator of this request.
vgProjection :: Lens' VolumesGet (Maybe VolumesGetProjection) Source #
Restrict information returned to a set of selected fields.