Network.Google.Resource.Books.Volumes.List

Performs a book search.

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

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

A resource alias for books.volumes.list method which the VolumesList request conforms to.

Creating a Request

volumesList

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:

• vlOrderBy
• vlMaxAllowedMaturityRating
• vlLibraryRestrict
• vlPartner
• vlQ
• vlDownload
• vlSource
• vlProjection
• vlFilter
• vlLangRestrict
• vlStartIndex
• vlMaxResults
• vlShowPreOrders
• vlPrintType

data VolumesList

Performs a book search.

See: volumesList smart constructor.

Instances

Eq VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

Methods

(==) :: VolumesList -> VolumesList -> Bool

(/=) :: VolumesList -> VolumesList -> Bool

Data VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

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

Defined in Network.Google.Resource.Books.Volumes.List

Methods

showsPrec :: Int -> VolumesList -> ShowS

show :: VolumesList -> String

showList :: [VolumesList] -> ShowS

Generic VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

Associated Types

type Rep VolumesList :: Type -> Type

Methods

from :: VolumesList -> Rep VolumesList x

to :: Rep VolumesList x -> VolumesList

GoogleRequest VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

Associated Types

type Rs VolumesList :: Type

type Scopes VolumesList :: [Symbol]

Methods

requestClient :: VolumesList -> GClient (Rs VolumesList)

type Rep VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

type Rep VolumesList = D1 (MetaData "VolumesList" "Network.Google.Resource.Books.Volumes.List" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "VolumesList'" PrefixI True) (((S1 (MetaSel (Just "_vlOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListOrderBy)) :*: (S1 (MetaSel (Just "_vlMaxAllowedMaturityRating") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListMaxAllowedMaturityRating)) :*: S1 (MetaSel (Just "_vlLibraryRestrict") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListLibraryRestrict)))) :*: ((S1 (MetaSel (Just "_vlPartner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_vlQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_vlDownload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListDownload)) :*: S1 (MetaSel (Just "_vlSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_vlProjection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListProjection)) :*: (S1 (MetaSel (Just "_vlFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListFilter)) :*: S1 (MetaSel (Just "_vlLangRestrict") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_vlStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_vlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))) :*: (S1 (MetaSel (Just "_vlShowPreOrders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_vlPrintType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe VolumesListPrintType)))))))

type Scopes VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

type Scopes VolumesList = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])

type Rs VolumesList

Defined in Network.Google.Resource.Books.Volumes.List

type Rs VolumesList = Volumes

Request Lenses

vlOrderBy :: Lens' VolumesList (Maybe VolumesListOrderBy)

Sort search results.

vlMaxAllowedMaturityRating :: Lens' VolumesList (Maybe VolumesListMaxAllowedMaturityRating)

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

vlLibraryRestrict :: Lens' VolumesList (Maybe VolumesListLibraryRestrict)

Restrict search to this user's library.

vlPartner :: Lens' VolumesList (Maybe Text)

Restrict and brand results for partner ID.

vlQ :: Lens' VolumesList Text

Full-text search query string.

vlDownload :: Lens' VolumesList (Maybe VolumesListDownload)

Restrict to volumes by download availability.

vlSource :: Lens' VolumesList (Maybe Text)

String to identify the originator of this request.

vlProjection :: Lens' VolumesList (Maybe VolumesListProjection)

Restrict information returned to a set of selected fields.

vlFilter :: Lens' VolumesList (Maybe VolumesListFilter)

Filter search results.

vlLangRestrict :: Lens' VolumesList (Maybe Text)

Restrict results to books with this language code.

vlStartIndex :: Lens' VolumesList (Maybe Word32)

Index of the first result to return (starts at 0)

vlMaxResults :: Lens' VolumesList (Maybe Word32)

Maximum number of results to return.

vlShowPreOrders :: Lens' VolumesList (Maybe Bool)

Set to true to show books available for preorder. Defaults to false.

vlPrintType :: Lens' VolumesList (Maybe VolumesListPrintType)

Restrict to books or magazines.