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.Surveys.Surveys.Start

Contents

REST Resource
Creating a Request
Request Lenses

Description

Begins running a survey.

See: Surveys API Reference for surveys.surveys.start.

Synopsis

type SurveysStartResource = "surveys" :> ("v2" :> ("surveys" :> (Capture "resourceId" Text :> ("start" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SurveysStartRequest :> Post '[JSON] SurveysStartResponse))))))
surveysStart :: Text -> SurveysStartRequest -> SurveysStart
data SurveysStart
ssResourceId :: Lens' SurveysStart Text
ssPayload :: Lens' SurveysStart SurveysStartRequest

REST Resource

type SurveysStartResource = "surveys" :> ("v2" :> ("surveys" :> (Capture "resourceId" Text :> ("start" :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SurveysStartRequest :> Post '[JSON] SurveysStartResponse)))))) Source #

A resource alias for surveys.surveys.start method which the SurveysStart request conforms to.

Creating a Request

surveysStart Source #

Arguments

:: Text	`ssResourceId`
-> SurveysStartRequest	`ssPayload`
-> SurveysStart

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

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

ssResourceId
ssPayload

data SurveysStart Source #

Begins running a survey.

See: surveysStart smart constructor.

Instances

Eq SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start Methods (==) :: SurveysStart -> SurveysStart -> Bool # (/=) :: SurveysStart -> SurveysStart -> Bool #
Data SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SurveysStart -> c SurveysStart # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SurveysStart # toConstr :: SurveysStart -> Constr # dataTypeOf :: SurveysStart -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SurveysStart) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SurveysStart) # gmapT :: (forall b. Data b => b -> b) -> SurveysStart -> SurveysStart # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SurveysStart -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SurveysStart -> r # gmapQ :: (forall d. Data d => d -> u) -> SurveysStart -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SurveysStart -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SurveysStart -> m SurveysStart # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SurveysStart -> m SurveysStart # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SurveysStart -> m SurveysStart #
Show SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start Methods showsPrec :: Int -> SurveysStart -> ShowS # show :: SurveysStart -> String # showList :: [SurveysStart] -> ShowS #
Generic SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start Associated Types type Rep SurveysStart :: Type -> Type # Methods from :: SurveysStart -> Rep SurveysStart x # to :: Rep SurveysStart x -> SurveysStart #
GoogleRequest SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start Associated Types type Rs SurveysStart :: Type # type Scopes SurveysStart :: [Symbol] # Methods requestClient :: SurveysStart -> GClient (Rs SurveysStart) #
type Rep SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start type Rep SurveysStart = D1 (MetaData "SurveysStart" "Network.Google.Resource.Surveys.Surveys.Start" "gogol-surveys-0.4.0-JDdOowllRumLCrJvGPiXO8" False) (C1 (MetaCons "SurveysStart'" PrefixI True) (S1 (MetaSel (Just "_ssResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ssPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SurveysStartRequest)))
type Scopes SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start type Scopes SurveysStart = "https://www.googleapis.com/auth/surveys" ': ("https://www.googleapis.com/auth/userinfo.email" ': ([] :: [Symbol]))
type Rs SurveysStart Source #
Instance details Defined in Network.Google.Resource.Surveys.Surveys.Start type Rs SurveysStart = SurveysStartResponse

Request Lenses

ssResourceId :: Lens' SurveysStart Text Source #

ssPayload :: Lens' SurveysStart SurveysStartRequest Source #

Multipart request metadata.