gogol-books-0.2.0: Google Books SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Books.Volumes.List

Contents

Description

Performs a book search.

See: Books API Reference for books.volumes.list.

Synopsis

REST Resource

type VolumesListResource = "books" :> ("v1" :> ("volumes" :> (QueryParam "q" Text :> (QueryParam "orderBy" VolumesListOrderBy :> (QueryParam "maxAllowedMaturityRating" VolumesListMaxAllowedMaturityRating :> (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

volumesList Source #

Arguments

:: Text

vlQ

-> 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.

Instances

Eq VolumesList Source # 
Data VolumesList Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VolumesList -> c VolumesList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VolumesList #

toConstr :: VolumesList -> Constr #

dataTypeOf :: VolumesList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c VolumesList) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VolumesList) #

gmapT :: (forall b. Data b => b -> b) -> VolumesList -> VolumesList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VolumesList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VolumesList -> r #

gmapQ :: (forall d. Data d => d -> u) -> VolumesList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> VolumesList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> VolumesList -> m VolumesList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VolumesList -> m VolumesList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VolumesList -> m VolumesList #

Show VolumesList Source # 
Generic VolumesList Source # 

Associated Types

type Rep VolumesList :: * -> * #

Methods

from :: VolumesList -> Rep VolumesList x #

to :: Rep VolumesList x -> VolumesList #

GoogleRequest VolumesList Source # 

Associated Types

type Rs VolumesList :: * #

type Scopes VolumesList :: [Symbol] #

Methods

requestClient :: VolumesList -> Client (Rs VolumesList) #

type Rep VolumesList Source # 
type Rep VolumesList = D1 (MetaData "VolumesList" "Network.Google.Resource.Books.Volumes.List" "gogol-books-0.2.0-5Ye9jkpXNyYIQzuxFUGse4" False) (C1 (MetaCons "VolumesList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vlOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListOrderBy))) ((:*:) (S1 (MetaSel (Just Symbol "_vlMaxAllowedMaturityRating") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListMaxAllowedMaturityRating))) (S1 (MetaSel (Just Symbol "_vlLibraryRestrict") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListLibraryRestrict))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vlPartner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_vlQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_vlDownload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListDownload))) (S1 (MetaSel (Just Symbol "_vlSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vlProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListProjection))) ((:*:) (S1 (MetaSel (Just Symbol "_vlFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListFilter))) (S1 (MetaSel (Just Symbol "_vlLangRestrict") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_vlStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))) (S1 (MetaSel (Just Symbol "_vlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))) ((:*:) (S1 (MetaSel (Just Symbol "_vlShowPreOrders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_vlPrintType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListPrintType))))))))
type Scopes VolumesList Source # 
type Scopes VolumesList = (:) Symbol "https://www.googleapis.com/auth/books" ([] Symbol)
type Rs VolumesList Source # 

Request Lenses

vlOrderBy :: Lens' VolumesList (Maybe VolumesListOrderBy) Source #

Sort search results.

vlMaxAllowedMaturityRating :: Lens' VolumesList (Maybe VolumesListMaxAllowedMaturityRating) Source #

The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

vlLibraryRestrict :: Lens' VolumesList (Maybe VolumesListLibraryRestrict) Source #

Restrict search to this user's library.

vlPartner :: Lens' VolumesList (Maybe Text) Source #

Restrict and brand results for partner ID.

vlQ :: Lens' VolumesList Text Source #

Full-text search query string.

vlDownload :: Lens' VolumesList (Maybe VolumesListDownload) Source #

Restrict to volumes by download availability.

vlSource :: Lens' VolumesList (Maybe Text) Source #

String to identify the originator of this request.

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.