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.Coordinate.Jobs.Patch

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.

See: Google Maps Coordinate API Reference for coordinate.jobs.patch.

Synopsis

REST Resource

type JobsPatchResource = "coordinate" :> ("v1" :> ("teams" :> (Capture "teamId" Text :> ("jobs" :> (Capture "jobId" (Textual Word64) :> (QueryParam "progress" JobsPatchProgress :> (QueryParam "note" Text :> (QueryParam "customerPhoneNumber" Text :> (QueryParam "customerName" Text :> (QueryParam "address" Text :> (QueryParam "assignee" Text :> (QueryParam "lat" (Textual Double) :> (QueryParam "lng" (Textual Double) :> (QueryParam "title" Text :> (QueryParams "customField" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Job :> Patch '[JSON] Job))))))))))))))))) Source #

A resource alias for coordinate.jobs.patch method which the JobsPatch request conforms to.

Creating a Request

jobsPatch Source #

Arguments

:: Word64	`jpJobId`
-> Text	`jpTeamId`
-> Job	`jpPayload`
-> JobsPatch

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

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

data JobsPatch Source #

Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics.

See: jobsPatch smart constructor.

Instances

Eq JobsPatch Source #
Methods (==) :: JobsPatch -> JobsPatch -> Bool # (/=) :: JobsPatch -> JobsPatch -> Bool #
Data JobsPatch Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JobsPatch -> c JobsPatch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JobsPatch # toConstr :: JobsPatch -> Constr # dataTypeOf :: JobsPatch -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c JobsPatch) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JobsPatch) # gmapT :: (forall b. Data b => b -> b) -> JobsPatch -> JobsPatch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JobsPatch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JobsPatch -> r # gmapQ :: (forall d. Data d => d -> u) -> JobsPatch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JobsPatch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JobsPatch -> m JobsPatch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JobsPatch -> m JobsPatch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JobsPatch -> m JobsPatch #
Show JobsPatch Source #
Methods showsPrec :: Int -> JobsPatch -> ShowS # show :: JobsPatch -> String # showList :: [JobsPatch] -> ShowS #
Generic JobsPatch Source #
Associated Types type Rep JobsPatch :: * -> * # Methods from :: JobsPatch -> Rep JobsPatch x # to :: Rep JobsPatch x -> JobsPatch #
GoogleRequest JobsPatch Source #
Associated Types type Rs JobsPatch :: * # type Scopes JobsPatch :: [Symbol] # Methods requestClient :: JobsPatch -> Client (Rs JobsPatch) #
type Rep JobsPatch Source #
type Rep JobsPatch = D1 (MetaData "JobsPatch" "Network.Google.Resource.Coordinate.Jobs.Patch" "gogol-maps-coordinate-0.3.0-7B21Gtc38Qp6D6sajauyPP" False) (C1 (MetaCons "JobsPatch'" PrefixI True) ((::) ((::) ((::) (S1 (MetaSel (Just Symbol "_jpJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Word64))) ((::) (S1 (MetaSel (Just Symbol "_jpProgress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobsPatchProgress))) (S1 (MetaSel (Just Symbol "_jpNote") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((::) (S1 (MetaSel (Just Symbol "_jpTeamId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((::) (S1 (MetaSel (Just Symbol "_jpCustomerPhoneNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_jpCustomerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_jpAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_jpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Job)) (S1 (MetaSel (Just Symbol "_jpAssignee") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_jpLat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double)))) (S1 (MetaSel (Just Symbol "_jpLng") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) ((::) (S1 (MetaSel (Just Symbol "_jpTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_jpCustomField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))))))
type Scopes JobsPatch Source #
type Scopes JobsPatch = (:) Symbol "https://www.googleapis.com/auth/coordinate" ([] Symbol)
type Rs JobsPatch Source #
type Rs JobsPatch = Job

Request Lenses

jpJobId :: Lens' JobsPatch Word64 Source #

Job number

jpProgress :: Lens' JobsPatch (Maybe JobsPatchProgress) Source #

Job progress

jpNote :: Lens' JobsPatch (Maybe Text) Source #

Job note as newline (Unix) separated string

jpTeamId :: Lens' JobsPatch Text Source #

Team ID

jpCustomerPhoneNumber :: Lens' JobsPatch (Maybe Text) Source #

Customer phone number

jpCustomerName :: Lens' JobsPatch (Maybe Text) Source #

Customer name

jpAddress :: Lens' JobsPatch (Maybe Text) Source #

Job address as newline (Unix) separated string

jpPayload :: Lens' JobsPatch Job Source #

Multipart request metadata.

jpAssignee :: Lens' JobsPatch (Maybe Text) Source #

Assignee email address, or empty string to unassign.

jpLat :: Lens' JobsPatch (Maybe Double) Source #

The latitude coordinate of this job's location.

jpLng :: Lens' JobsPatch (Maybe Double) Source #

The longitude coordinate of this job's location.

jpTitle :: Lens' JobsPatch (Maybe Text) Source #

Job title

jpCustomField :: Lens' JobsPatch [Text] Source #

Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.