Network.Google.Resource.Books.Bookshelves.Volumes.List

Retrieves volumes in a specific bookshelf for the specified user.

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

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

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

Creating a Request

bookshelvesVolumesList

Arguments

:: Text

bvlUserId

-> Text

bvlShelf

-> BookshelvesVolumesList

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:

• bvlUserId
• bvlShelf
• bvlSource
• bvlStartIndex
• bvlMaxResults
• bvlShowPreOrders

data BookshelvesVolumesList

Retrieves volumes in a specific bookshelf for the specified user.

See: bookshelvesVolumesList smart constructor.

Instances

Eq BookshelvesVolumesList

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

Methods

(==) :: BookshelvesVolumesList -> BookshelvesVolumesList -> Bool

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

Data BookshelvesVolumesList

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

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

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

Methods

showsPrec :: Int -> BookshelvesVolumesList -> ShowS

show :: BookshelvesVolumesList -> String

showList :: [BookshelvesVolumesList] -> ShowS

Generic BookshelvesVolumesList

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

Associated Types

type Rep BookshelvesVolumesList :: Type -> Type

Methods

from :: BookshelvesVolumesList -> Rep BookshelvesVolumesList x

to :: Rep BookshelvesVolumesList x -> BookshelvesVolumesList

GoogleRequest BookshelvesVolumesList

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

Associated Types

type Rs BookshelvesVolumesList :: Type

type Scopes BookshelvesVolumesList :: [Symbol]

Methods

requestClient :: BookshelvesVolumesList -> GClient (Rs BookshelvesVolumesList)

type Rep BookshelvesVolumesList

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

type Rep BookshelvesVolumesList = D1 (MetaData "BookshelvesVolumesList" "Network.Google.Resource.Books.Bookshelves.Volumes.List" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "BookshelvesVolumesList'" PrefixI True) ((S1 (MetaSel (Just "_bvlUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_bvlShelf") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_bvlSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_bvlStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: (S1 (MetaSel (Just "_bvlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_bvlShowPreOrders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))))

type Scopes BookshelvesVolumesList

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

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

type Rs BookshelvesVolumesList

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

type Rs BookshelvesVolumesList = Volumes

Request Lenses

bvlUserId :: Lens' BookshelvesVolumesList Text

ID of user for whom to retrieve bookshelf volumes.

bvlShelf :: Lens' BookshelvesVolumesList Text

ID of bookshelf to retrieve volumes.

bvlSource :: Lens' BookshelvesVolumesList (Maybe Text)

String to identify the originator of this request.

bvlStartIndex :: Lens' BookshelvesVolumesList (Maybe Word32)

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

bvlMaxResults :: Lens' BookshelvesVolumesList (Maybe Word32)

Maximum number of results to return

bvlShowPreOrders :: Lens' BookshelvesVolumesList (Maybe Bool)

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