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

Network.Google.Resource.Books.Volumes.UserUploaded.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Return a list of books uploaded by the current user.

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

Synopsis

type VolumesUserUploadedListResource = "books" :> ("v1" :> ("volumes" :> ("useruploaded" :> (QueryParams "processingState" VolumesUserUploadedListProcessingState :> (QueryParam "locale" Text :> (QueryParams "volumeId" Text :> (QueryParam "source" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Volumes))))))))))
volumesUserUploadedList :: VolumesUserUploadedList
data VolumesUserUploadedList
vuulProcessingState :: Lens' VolumesUserUploadedList [VolumesUserUploadedListProcessingState]
vuulLocale :: Lens' VolumesUserUploadedList (Maybe Text)
vuulVolumeId :: Lens' VolumesUserUploadedList [Text]
vuulSource :: Lens' VolumesUserUploadedList (Maybe Text)
vuulStartIndex :: Lens' VolumesUserUploadedList (Maybe Word32)
vuulMaxResults :: Lens' VolumesUserUploadedList (Maybe Word32)

REST Resource

type VolumesUserUploadedListResource = "books" :> ("v1" :> ("volumes" :> ("useruploaded" :> (QueryParams "processingState" VolumesUserUploadedListProcessingState :> (QueryParam "locale" Text :> (QueryParams "volumeId" Text :> (QueryParam "source" Text :> (QueryParam "startIndex" (Textual Word32) :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Volumes)))))))))) Source #

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

Creating a Request

volumesUserUploadedList :: VolumesUserUploadedList Source #

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

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

data VolumesUserUploadedList Source #

Return a list of books uploaded by the current user.

See: volumesUserUploadedList smart constructor.

Instances

Eq VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List Methods (==) :: VolumesUserUploadedList -> VolumesUserUploadedList -> Bool # (/=) :: VolumesUserUploadedList -> VolumesUserUploadedList -> Bool #
Data VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VolumesUserUploadedList -> c VolumesUserUploadedList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VolumesUserUploadedList # toConstr :: VolumesUserUploadedList -> Constr # dataTypeOf :: VolumesUserUploadedList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VolumesUserUploadedList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VolumesUserUploadedList) # gmapT :: (forall b. Data b => b -> b) -> VolumesUserUploadedList -> VolumesUserUploadedList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VolumesUserUploadedList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VolumesUserUploadedList -> r # gmapQ :: (forall d. Data d => d -> u) -> VolumesUserUploadedList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> VolumesUserUploadedList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> VolumesUserUploadedList -> m VolumesUserUploadedList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VolumesUserUploadedList -> m VolumesUserUploadedList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VolumesUserUploadedList -> m VolumesUserUploadedList #
Show VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List Methods showsPrec :: Int -> VolumesUserUploadedList -> ShowS # show :: VolumesUserUploadedList -> String # showList :: [VolumesUserUploadedList] -> ShowS #
Generic VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List Associated Types type Rep VolumesUserUploadedList :: Type -> Type # Methods from :: VolumesUserUploadedList -> Rep VolumesUserUploadedList x # to :: Rep VolumesUserUploadedList x -> VolumesUserUploadedList #
GoogleRequest VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List Associated Types type Rs VolumesUserUploadedList :: Type # type Scopes VolumesUserUploadedList :: [Symbol] # Methods requestClient :: VolumesUserUploadedList -> GClient (Rs VolumesUserUploadedList) #
type Rep VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List type Rep VolumesUserUploadedList = D1 (MetaData "VolumesUserUploadedList" "Network.Google.Resource.Books.Volumes.UserUploaded.List" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "VolumesUserUploadedList'" PrefixI True) ((S1 (MetaSel (Just "_vuulProcessingState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [VolumesUserUploadedListProcessingState])) :: (S1 (MetaSel (Just "_vuulLocale") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_vuulVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 (MetaSel (Just "_vuulSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_vuulStartIndex") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))) :*: S1 (MetaSel (Just "_vuulMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32)))))))
type Scopes VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List type Scopes VolumesUserUploadedList = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])
type Rs VolumesUserUploadedList Source #
Instance details Defined in Network.Google.Resource.Books.Volumes.UserUploaded.List type Rs VolumesUserUploadedList = Volumes

Request Lenses

vuulProcessingState :: Lens' VolumesUserUploadedList [VolumesUserUploadedListProcessingState] Source #

The processing state of the user uploaded volumes to be returned.

vuulLocale :: Lens' VolumesUserUploadedList (Maybe Text) Source #

ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

vuulVolumeId :: Lens' VolumesUserUploadedList [Text] Source #

The ids of the volumes to be returned. If not specified all that match the processingState are returned.

vuulSource :: Lens' VolumesUserUploadedList (Maybe Text) Source #

String to identify the originator of this request.

vuulStartIndex :: Lens' VolumesUserUploadedList (Maybe Word32) Source #

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

vuulMaxResults :: Lens' VolumesUserUploadedList (Maybe Word32) Source #

Maximum number of results to return.