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.MapsCoordinate
Description
Lets you view and manage jobs in a Coordinate team.
- mapsCoordinateService :: ServiceConfig
- coordinateScope :: Proxy '["https://www.googleapis.com/auth/coordinate"]
- coordinateReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/coordinate.readonly"]
- type MapsCoordinateAPI = SchedulePatchResource :<|> (ScheduleGetResource :<|> (ScheduleUpdateResource :<|> (LocationListResource :<|> (CustomFieldDefListResource :<|> (JobsInsertResource :<|> (JobsListResource :<|> (JobsPatchResource :<|> (JobsGetResource :<|> (JobsUpdateResource :<|> (TeamListResource :<|> WorkerListResource))))))))))
- module Network.Google.Resource.Coordinate.CustomFieldDef.List
- module Network.Google.Resource.Coordinate.Jobs.Get
- module Network.Google.Resource.Coordinate.Jobs.Insert
- module Network.Google.Resource.Coordinate.Jobs.List
- module Network.Google.Resource.Coordinate.Jobs.Patch
- module Network.Google.Resource.Coordinate.Jobs.Update
- module Network.Google.Resource.Coordinate.Location.List
- module Network.Google.Resource.Coordinate.Schedule.Get
- module Network.Google.Resource.Coordinate.Schedule.Patch
- module Network.Google.Resource.Coordinate.Schedule.Update
- module Network.Google.Resource.Coordinate.Team.List
- module Network.Google.Resource.Coordinate.Worker.List
- data LocationListResponse
- locationListResponse :: LocationListResponse
- llrTokenPagination :: Lens' LocationListResponse (Maybe TokenPagination)
- llrNextPageToken :: Lens' LocationListResponse (Maybe Text)
- llrKind :: Lens' LocationListResponse Text
- llrItems :: Lens' LocationListResponse [LocationRecord]
- data JobsPatchProgress
- data TokenPagination
- tokenPagination :: TokenPagination
- tpNextPageToken :: Lens' TokenPagination (Maybe Text)
- tpKind :: Lens' TokenPagination Text
- tpPreviousPageToken :: Lens' TokenPagination (Maybe Text)
- data WorkerListResponse
- workerListResponse :: WorkerListResponse
- wlrKind :: Lens' WorkerListResponse Text
- wlrItems :: Lens' WorkerListResponse [Worker]
- data Schedule
- schedule :: Schedule
- sAllDay :: Lens' Schedule (Maybe Bool)
- sStartTime :: Lens' Schedule (Maybe Word64)
- sKind :: Lens' Schedule Text
- sEndTime :: Lens' Schedule (Maybe Word64)
- sDuration :: Lens' Schedule (Maybe Word64)
- data Location
- location :: Location
- lAddressLine :: Lens' Location [Text]
- lKind :: Lens' Location Text
- lLat :: Lens' Location (Maybe Double)
- lLng :: Lens' Location (Maybe Double)
- data JobsUpdateProgress
- data JobState
- jobState :: JobState
- jsLocation :: Lens' JobState (Maybe Location)
- jsProgress :: Lens' JobState (Maybe Text)
- jsNote :: Lens' JobState [Text]
- jsKind :: Lens' JobState Text
- jsCustomerPhoneNumber :: Lens' JobState (Maybe Text)
- jsCustomerName :: Lens' JobState (Maybe Text)
- jsAssignee :: Lens' JobState (Maybe Text)
- jsCustomFields :: Lens' JobState (Maybe CustomFields)
- jsTitle :: Lens' JobState (Maybe Text)
- data CustomFieldDef
- customFieldDef :: CustomFieldDef
- cfdEnabled :: Lens' CustomFieldDef (Maybe Bool)
- cfdKind :: Lens' CustomFieldDef Text
- cfdName :: Lens' CustomFieldDef (Maybe Text)
- cfdRequiredForCheckout :: Lens' CustomFieldDef (Maybe Bool)
- cfdId :: Lens' CustomFieldDef (Maybe Int64)
- cfdEnumitems :: Lens' CustomFieldDef [EnumItemDef]
- cfdType :: Lens' CustomFieldDef (Maybe Text)
- data JobListResponse
- jobListResponse :: JobListResponse
- jlrNextPageToken :: Lens' JobListResponse (Maybe Text)
- jlrKind :: Lens' JobListResponse Text
- jlrItems :: Lens' JobListResponse [Job]
- data JobChange
- jobChange :: JobChange
- jcState :: Lens' JobChange (Maybe JobState)
- jcKind :: Lens' JobChange Text
- jcTimestamp :: Lens' JobChange (Maybe Word64)
- data TeamListResponse
- teamListResponse :: TeamListResponse
- tlrKind :: Lens' TeamListResponse Text
- tlrItems :: Lens' TeamListResponse [Team]
- data CustomFieldDefListResponse
- customFieldDefListResponse :: CustomFieldDefListResponse
- cfdlrKind :: Lens' CustomFieldDefListResponse Text
- cfdlrItems :: Lens' CustomFieldDefListResponse [CustomFieldDef]
- data Job
- job :: Job
- jState :: Lens' Job (Maybe JobState)
- jKind :: Lens' Job Text
- jJobChange :: Lens' Job [JobChange]
- jId :: Lens' Job (Maybe Word64)
- data CustomFields
- customFields :: CustomFields
- cfKind :: Lens' CustomFields Text
- cfCustomField :: Lens' CustomFields [CustomField]
- data Team
- team :: Team
- tKind :: Lens' Team Text
- tName :: Lens' Team (Maybe Text)
- tId :: Lens' Team (Maybe Text)
- data LocationRecord
- locationRecord :: LocationRecord
- lrKind :: Lens' LocationRecord Text
- lrLatitude :: Lens' LocationRecord (Maybe Double)
- lrConfidenceRadius :: Lens' LocationRecord (Maybe Double)
- lrLongitude :: Lens' LocationRecord (Maybe Double)
- lrCollectionTime :: Lens' LocationRecord (Maybe Int64)
- data Worker
- worker :: Worker
- wKind :: Lens' Worker Text
- wId :: Lens' Worker (Maybe Text)
- data CustomField
- customField :: CustomField
- cCustomFieldId :: Lens' CustomField (Maybe Int64)
- cKind :: Lens' CustomField Text
- cValue :: Lens' CustomField (Maybe Text)
- data EnumItemDef
- enumItemDef :: EnumItemDef
- eidKind :: Lens' EnumItemDef Text
- eidValue :: Lens' EnumItemDef (Maybe Text)
- eidActive :: Lens' EnumItemDef (Maybe Bool)
Service Configuration
mapsCoordinateService :: ServiceConfig #
Default request referring to version v1
of the Google Maps Coordinate API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
coordinateScope :: Proxy '["https://www.googleapis.com/auth/coordinate"] #
View and manage your Google Maps Coordinate jobs
coordinateReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/coordinate.readonly"] #
View your Google Coordinate jobs
API Declaration
type MapsCoordinateAPI = SchedulePatchResource :<|> (ScheduleGetResource :<|> (ScheduleUpdateResource :<|> (LocationListResource :<|> (CustomFieldDefListResource :<|> (JobsInsertResource :<|> (JobsListResource :<|> (JobsPatchResource :<|> (JobsGetResource :<|> (JobsUpdateResource :<|> (TeamListResource :<|> WorkerListResource)))))))))) #
Represents the entirety of the methods and resources available for the Google Maps Coordinate API service.
Resources
coordinate.customFieldDef.list
coordinate.jobs.get
coordinate.jobs.insert
coordinate.jobs.list
coordinate.jobs.patch
coordinate.jobs.update
coordinate.location.list
coordinate.schedule.get
coordinate.schedule.patch
coordinate.schedule.update
coordinate.team.list
coordinate.worker.list
Types
LocationListResponse
data LocationListResponse #
Response from a List Locations request.
See: locationListResponse
smart constructor.
locationListResponse :: LocationListResponse #
Creates a value of LocationListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llrTokenPagination :: Lens' LocationListResponse (Maybe TokenPagination) #
Pagination information for token pagination.
llrNextPageToken :: Lens' LocationListResponse (Maybe Text) #
A token to provide to get the next page of results.
llrKind :: Lens' LocationListResponse Text #
Identifies this object as a list of locations.
llrItems :: Lens' LocationListResponse [LocationRecord] #
Locations in the collection.
JobsPatchProgress
data JobsPatchProgress #
Job progress
Constructors
Completed |
|
InProgress |
|
NotAccepted |
|
NotStarted |
|
Obsolete |
|
Instances
TokenPagination
data TokenPagination #
Pagination information.
See: tokenPagination
smart constructor.
tokenPagination :: TokenPagination #
Creates a value of TokenPagination
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpNextPageToken :: Lens' TokenPagination (Maybe Text) #
A token to provide to get the next page of results.
tpKind :: Lens' TokenPagination Text #
Identifies this object as pagination information.
tpPreviousPageToken :: Lens' TokenPagination (Maybe Text) #
A token to provide to get the previous page of results.
WorkerListResponse
data WorkerListResponse #
Response from a List Workers request.
See: workerListResponse
smart constructor.
workerListResponse :: WorkerListResponse #
Creates a value of WorkerListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wlrKind :: Lens' WorkerListResponse Text #
Identifies this object as a list of workers.
wlrItems :: Lens' WorkerListResponse [Worker] #
Workers in the collection.
Schedule
Job schedule.
See: schedule
smart constructor.
sAllDay :: Lens' Schedule (Maybe Bool) #
Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
Location
Location of a job.
See: location
smart constructor.
Creates a value of Location
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lAddressLine :: Lens' Location [Text] #
Address.
JobsUpdateProgress
data JobsUpdateProgress #
Job progress
Constructors
JUPCompleted |
|
JUPInProgress |
|
JUPNotAccepted |
|
JUPNotStarted |
|
JUPObsolete |
|
Instances
JobState
Current state of a job.
See: jobState
smart constructor.
Creates a value of JobState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsAssignee :: Lens' JobState (Maybe Text) #
Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
jsCustomFields :: Lens' JobState (Maybe CustomFields) #
Custom fields.
CustomFieldDef
customFieldDef :: CustomFieldDef #
Creates a value of CustomFieldDef
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfdEnabled :: Lens' CustomFieldDef (Maybe Bool) #
Whether the field is enabled.
cfdKind :: Lens' CustomFieldDef Text #
Identifies this object as a custom field definition.
cfdRequiredForCheckout :: Lens' CustomFieldDef (Maybe Bool) #
Whether the field is required for checkout.
cfdEnumitems :: Lens' CustomFieldDef [EnumItemDef] #
List of enum items for this custom field. Populated only if the field type is enum. Enum fields appear as 'lists' in the Coordinate web and mobile UI.
JobListResponse
data JobListResponse #
Response from a List Jobs request.
See: jobListResponse
smart constructor.
jobListResponse :: JobListResponse #
Creates a value of JobListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jlrNextPageToken :: Lens' JobListResponse (Maybe Text) #
A token to provide to get the next page of results.
jlrKind :: Lens' JobListResponse Text #
Identifies this object as a list of jobs.
jlrItems :: Lens' JobListResponse [Job] #
Jobs in the collection.
JobChange
Change to a job. For example assigning the job to a different worker.
See: jobChange
smart constructor.
Creates a value of JobChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jcState :: Lens' JobChange (Maybe JobState) #
Change applied to the job. Only the fields that were changed are set.
TeamListResponse
data TeamListResponse #
Response from a List Teams request.
See: teamListResponse
smart constructor.
teamListResponse :: TeamListResponse #
Creates a value of TeamListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlrKind :: Lens' TeamListResponse Text #
Identifies this object as a list of teams.
tlrItems :: Lens' TeamListResponse [Team] #
Teams in the collection.
CustomFieldDefListResponse
data CustomFieldDefListResponse #
Collection of custom field definitions for a team.
See: customFieldDefListResponse
smart constructor.
customFieldDefListResponse :: CustomFieldDefListResponse #
Creates a value of CustomFieldDefListResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfdlrKind :: Lens' CustomFieldDefListResponse Text #
Identifies this object as a collection of custom field definitions in a team.
cfdlrItems :: Lens' CustomFieldDefListResponse [CustomFieldDef] #
Collection of custom field definitions in a team.
Job
A job.
See: job
smart constructor.
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jJobChange :: Lens' Job [JobChange] #
List of job changes since it was created. The first change corresponds to the state of the job when it was created.
CustomFields
customFields :: CustomFields #
Creates a value of CustomFields
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfKind :: Lens' CustomFields Text #
Identifies this object as a collection of custom fields.
cfCustomField :: Lens' CustomFields [CustomField] #
Collection of custom fields.
Team
A Coordinate team.
See: team
smart constructor.
tId :: Lens' Team (Maybe Text) #
Team id, as found in a coordinate team url e.g. https://coordinate.google.com/f/xyz where "xyz" is the team id.
LocationRecord
locationRecord :: LocationRecord #
Creates a value of LocationRecord
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrKind :: Lens' LocationRecord Text #
Identifies this object as a location.
lrLatitude :: Lens' LocationRecord (Maybe Double) #
Latitude.
lrConfidenceRadius :: Lens' LocationRecord (Maybe Double) #
The location accuracy in meters. This is the radius of a 95% confidence interval around the location measurement.
lrLongitude :: Lens' LocationRecord (Maybe Double) #
Longitude.
lrCollectionTime :: Lens' LocationRecord (Maybe Int64) #
The collection time in milliseconds since the epoch.
Worker
A worker in a Coordinate team.
See: worker
smart constructor.
wId :: Lens' Worker (Maybe Text) #
Worker email address. If a worker has been deleted from your team, the email address will appear as DELETED_USER.
CustomField
Creates a value of CustomField
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCustomFieldId :: Lens' CustomField (Maybe Int64) #
Custom field id.
cKind :: Lens' CustomField Text #
Identifies this object as a custom field.
EnumItemDef
Creates a value of EnumItemDef
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eidKind :: Lens' EnumItemDef Text #
Identifies this object as an enum item definition.