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.Bookshelves.Volumes.List

Contents

Description

Retrieves volumes in a specific bookshelf for the specified user.

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

Synopsis

REST Resource

type BookshelvesVolumesListResource = "books" :> ("v1" :> ("users" :> (Capture "userId" Text :> ("bookshelves" :> (Capture "shelf" Text :> ("volumes" :> (QueryParam "source" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "showPreorders" Bool :> (QueryParam "alt" AltJSON :> Get '[JSON] Volumes))))))))))) Source #

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

Creating a Request

bookshelvesVolumesList Source #

Creates a value of BookshelvesVolumesList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data BookshelvesVolumesList Source #

Retrieves volumes in a specific bookshelf for the specified user.

See: bookshelvesVolumesList smart constructor.

Instances

Eq BookshelvesVolumesList Source # 
Data BookshelvesVolumesList Source # 

Methods

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

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

toConstr :: BookshelvesVolumesList -> Constr #

dataTypeOf :: BookshelvesVolumesList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show BookshelvesVolumesList Source # 
Generic BookshelvesVolumesList Source # 
GoogleRequest BookshelvesVolumesList Source # 
type Rep BookshelvesVolumesList Source # 
type Rep BookshelvesVolumesList = D1 (MetaData "BookshelvesVolumesList" "Network.Google.Resource.Books.Bookshelves.Volumes.List" "gogol-books-0.2.0-5Ye9jkpXNyYIQzuxFUGse4" False) (C1 (MetaCons "BookshelvesVolumesList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_bvlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_bvlShelf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_bvlSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_bvlStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))) ((:*:) (S1 (MetaSel (Just Symbol "_bvlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))) (S1 (MetaSel (Just Symbol "_bvlShowPreOrders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))))
type Scopes BookshelvesVolumesList Source # 
type Scopes BookshelvesVolumesList = (:) Symbol "https://www.googleapis.com/auth/books" ([] Symbol)
type Rs BookshelvesVolumesList Source # 

Request Lenses

bvlUserId :: Lens' BookshelvesVolumesList Text Source #

ID of user for whom to retrieve bookshelf volumes.

bvlShelf :: Lens' BookshelvesVolumesList Text Source #

ID of bookshelf to retrieve volumes.

bvlSource :: Lens' BookshelvesVolumesList (Maybe Text) Source #

String to identify the originator of this request.

bvlStartIndex :: Lens' BookshelvesVolumesList (Maybe Word32) Source #

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

bvlMaxResults :: Lens' BookshelvesVolumesList (Maybe Word32) Source #

Maximum number of results to return

bvlShowPreOrders :: Lens' BookshelvesVolumesList (Maybe Bool) Source #

Set to true to show pre-ordered books. Defaults to false.