Copyright | (c) 2015 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 |
Updates a job. Fields that are set in the job state will be updated.
See: Google Maps Coordinate API Reference for coordinate.jobs.update
.
- type JobsUpdateResource = "coordinate" :> ("v1" :> ("teams" :> (Capture "teamId" Text :> ("jobs" :> (Capture "jobId" (Textual Word64) :> (QueryParam "progress" JobsUpdateProgress :> (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 :> Put `[JSON]` Job)))))))))))))))))
- jobsUpdate :: Word64 -> Text -> Job -> JobsUpdate
- data JobsUpdate
- juJobId :: Lens' JobsUpdate Word64
- juProgress :: Lens' JobsUpdate (Maybe JobsUpdateProgress)
- juNote :: Lens' JobsUpdate (Maybe Text)
- juTeamId :: Lens' JobsUpdate Text
- juCustomerPhoneNumber :: Lens' JobsUpdate (Maybe Text)
- juCustomerName :: Lens' JobsUpdate (Maybe Text)
- juAddress :: Lens' JobsUpdate (Maybe Text)
- juPayload :: Lens' JobsUpdate Job
- juAssignee :: Lens' JobsUpdate (Maybe Text)
- juLat :: Lens' JobsUpdate (Maybe Double)
- juLng :: Lens' JobsUpdate (Maybe Double)
- juTitle :: Lens' JobsUpdate (Maybe Text)
- juCustomField :: Lens' JobsUpdate [Text]
REST Resource
type JobsUpdateResource = "coordinate" :> ("v1" :> ("teams" :> (Capture "teamId" Text :> ("jobs" :> (Capture "jobId" (Textual Word64) :> (QueryParam "progress" JobsUpdateProgress :> (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 :> Put `[JSON]` Job))))))))))))))))) Source
A resource alias for coordinate.jobs.update
method which the
JobsUpdate
request conforms to.
Creating a Request
Creates a value of JobsUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data JobsUpdate Source
Updates a job. Fields that are set in the job state will be updated.
See: jobsUpdate
smart constructor.
Request Lenses
juJobId :: Lens' JobsUpdate Word64 Source
Job number
juProgress :: Lens' JobsUpdate (Maybe JobsUpdateProgress) Source
Job progress
juTeamId :: Lens' JobsUpdate Text Source
Team ID
juCustomerPhoneNumber :: Lens' JobsUpdate (Maybe Text) Source
Customer phone number
juCustomerName :: Lens' JobsUpdate (Maybe Text) Source
Customer name
juPayload :: Lens' JobsUpdate Job Source
Multipart request metadata.
juAssignee :: Lens' JobsUpdate (Maybe Text) Source
Assignee email address, or empty string to unassign.
juCustomField :: Lens' JobsUpdate [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.