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.LibraryAgent.Shelves.Books.Borrow

Contents

REST Resource
Creating a Request
Request Lenses

Description

Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions.

See: Library Agent API Reference for libraryagent.shelves.books.borrow.

Synopsis

type ShelvesBooksBorrowResource = "v1" :> (CaptureMode "name" "borrow" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] GoogleExampleLibraryagentV1Book)))))))
shelvesBooksBorrow :: Text -> ShelvesBooksBorrow
data ShelvesBooksBorrow
sbbXgafv :: Lens' ShelvesBooksBorrow (Maybe Xgafv)
sbbUploadProtocol :: Lens' ShelvesBooksBorrow (Maybe Text)
sbbAccessToken :: Lens' ShelvesBooksBorrow (Maybe Text)
sbbUploadType :: Lens' ShelvesBooksBorrow (Maybe Text)
sbbName :: Lens' ShelvesBooksBorrow Text
sbbCallback :: Lens' ShelvesBooksBorrow (Maybe Text)

REST Resource

type ShelvesBooksBorrowResource = "v1" :> (CaptureMode "name" "borrow" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] GoogleExampleLibraryagentV1Book))))))) Source #

A resource alias for libraryagent.shelves.books.borrow method which the ShelvesBooksBorrow request conforms to.

Creating a Request

shelvesBooksBorrow Source #

Arguments

:: Text	`sbbName`
-> ShelvesBooksBorrow

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

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

data ShelvesBooksBorrow Source #

Borrow a book from the library. Returns the book if it is borrowed successfully. Returns NOT_FOUND if the book does not exist in the library. Returns quota exceeded error if the amount of books borrowed exceeds allocation quota in any dimensions.

See: shelvesBooksBorrow smart constructor.

Instances

Eq ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow Methods (==) :: ShelvesBooksBorrow -> ShelvesBooksBorrow -> Bool # (/=) :: ShelvesBooksBorrow -> ShelvesBooksBorrow -> Bool #
Data ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ShelvesBooksBorrow -> c ShelvesBooksBorrow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ShelvesBooksBorrow # toConstr :: ShelvesBooksBorrow -> Constr # dataTypeOf :: ShelvesBooksBorrow -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ShelvesBooksBorrow) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ShelvesBooksBorrow) # gmapT :: (forall b. Data b => b -> b) -> ShelvesBooksBorrow -> ShelvesBooksBorrow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ShelvesBooksBorrow -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ShelvesBooksBorrow -> r # gmapQ :: (forall d. Data d => d -> u) -> ShelvesBooksBorrow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ShelvesBooksBorrow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ShelvesBooksBorrow -> m ShelvesBooksBorrow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ShelvesBooksBorrow -> m ShelvesBooksBorrow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ShelvesBooksBorrow -> m ShelvesBooksBorrow #
Show ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow Methods showsPrec :: Int -> ShelvesBooksBorrow -> ShowS # show :: ShelvesBooksBorrow -> String # showList :: [ShelvesBooksBorrow] -> ShowS #
Generic ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow Associated Types type Rep ShelvesBooksBorrow :: Type -> Type # Methods from :: ShelvesBooksBorrow -> Rep ShelvesBooksBorrow x # to :: Rep ShelvesBooksBorrow x -> ShelvesBooksBorrow #
GoogleRequest ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow Associated Types type Rs ShelvesBooksBorrow :: Type # type Scopes ShelvesBooksBorrow :: [Symbol] # Methods requestClient :: ShelvesBooksBorrow -> GClient (Rs ShelvesBooksBorrow) #
type Rep ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow type Rep ShelvesBooksBorrow = D1 (MetaData "ShelvesBooksBorrow" "Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow" "gogol-libraryagent-0.4.0-3DDw7qDFYgp6HuQ2dTY0m5" False) (C1 (MetaCons "ShelvesBooksBorrow'" PrefixI True) ((S1 (MetaSel (Just "_sbbXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_sbbUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sbbAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_sbbUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_sbbName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sbbCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow type Scopes ShelvesBooksBorrow = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs ShelvesBooksBorrow Source #
Instance details Defined in Network.Google.Resource.LibraryAgent.Shelves.Books.Borrow type Rs ShelvesBooksBorrow = GoogleExampleLibraryagentV1Book

Request Lenses

sbbXgafv :: Lens' ShelvesBooksBorrow (Maybe Xgafv) Source #

V1 error format.

sbbUploadProtocol :: Lens' ShelvesBooksBorrow (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

sbbAccessToken :: Lens' ShelvesBooksBorrow (Maybe Text) Source #

OAuth access token.

sbbUploadType :: Lens' ShelvesBooksBorrow (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

sbbName :: Lens' ShelvesBooksBorrow Text Source #

The name of the book to borrow.

sbbCallback :: Lens' ShelvesBooksBorrow (Maybe Text) Source #

JSONP