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 |
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 Source #
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"] Source #
View and manage your Google Maps Coordinate jobs
coordinateReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/coordinate.readonly"] Source #
View your Google Coordinate jobs
API Declaration
type MapsCoordinateAPI = SchedulePatchResource :<|> (ScheduleGetResource :<|> (ScheduleUpdateResource :<|> (LocationListResource :<|> (CustomFieldDefListResource :<|> (JobsInsertResource :<|> (JobsListResource :<|> (JobsPatchResource :<|> (JobsGetResource :<|> (JobsUpdateResource :<|> (TeamListResource :<|> WorkerListResource)))))))))) Source #
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 Source #
Response from a List Locations request.
See: locationListResponse
smart constructor.
locationListResponse :: LocationListResponse Source #
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) Source #
Pagination information for token pagination.
llrNextPageToken :: Lens' LocationListResponse (Maybe Text) Source #
A token to provide to get the next page of results.
llrItems :: Lens' LocationListResponse [LocationRecord] Source #
Locations in the collection.
JobsPatchProgress
data JobsPatchProgress Source #
Job progress
Completed |
|
InProgress |
|
NotAccepted |
|
NotStarted |
|
Obsolete |
|
TokenPagination
data TokenPagination Source #
Pagination information.
See: tokenPagination
smart constructor.
tokenPagination :: TokenPagination Source #
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) Source #
A token to provide to get the next page of results.
tpPreviousPageToken :: Lens' TokenPagination (Maybe Text) Source #
A token to provide to get the previous page of results.
WorkerListResponse
data WorkerListResponse Source #
Response from a List Workers request.
See: workerListResponse
smart constructor.
workerListResponse :: WorkerListResponse Source #
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:
Schedule
Job schedule.
See: schedule
smart constructor.
sAllDay :: Lens' Schedule (Maybe Bool) Source #
Whether the job is scheduled for the whole day. Time of day in start/end times is ignored if this is true.
sStartTime :: Lens' Schedule (Maybe Word64) Source #
Scheduled start time in milliseconds since epoch.
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:
JobsUpdateProgress
data JobsUpdateProgress Source #
Job progress
JUPCompleted |
|
JUPInProgress |
|
JUPNotAccepted |
|
JUPNotStarted |
|
JUPObsolete |
|
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) Source #
Email address of the assignee, or the string "DELETED_USER" if the account is no longer available.
jsCustomFields :: Lens' JobState (Maybe CustomFields) Source #
Custom fields.
CustomFieldDef
data CustomFieldDef Source #
Custom field definition.
See: customFieldDef
smart constructor.
customFieldDef :: CustomFieldDef Source #
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) Source #
Whether the field is enabled.
cfdRequiredForCheckout :: Lens' CustomFieldDef (Maybe Bool) Source #
Whether the field is required for checkout.
cfdEnumitems :: Lens' CustomFieldDef [EnumItemDef] Source #
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 Source #
Response from a List Jobs request.
See: jobListResponse
smart constructor.
jobListResponse :: JobListResponse Source #
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) Source #
A token to provide to get the next page of results.
JobChange
Change to a job. For example assigning the job to a different worker.
See: jobChange
smart constructor.
jobChange :: JobChange Source #
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) Source #
Change applied to the job. Only the fields that were changed are set.
TeamListResponse
data TeamListResponse Source #
Response from a List Teams request.
See: teamListResponse
smart constructor.
teamListResponse :: TeamListResponse Source #
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:
CustomFieldDefListResponse
data CustomFieldDefListResponse Source #
Collection of custom field definitions for a team.
See: customFieldDefListResponse
smart constructor.
customFieldDefListResponse :: CustomFieldDefListResponse Source #
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 Source #
Identifies this object as a collection of custom field definitions in a team.
cfdlrItems :: Lens' CustomFieldDefListResponse [CustomFieldDef] Source #
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] Source #
List of job changes since it was created. The first change corresponds to the state of the job when it was created.
CustomFields
data CustomFields Source #
Collection of custom fields.
See: customFields
smart constructor.
customFields :: CustomFields Source #
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:
cfCustomField :: Lens' CustomFields [CustomField] Source #
Collection of custom fields.
Team
A Coordinate team.
See: team
smart constructor.
tId :: Lens' Team (Maybe Text) Source #
Team id, as found in a coordinate team url e.g. https://coordinate.google.com/f/xyz where "xyz" is the team id.
LocationRecord
data LocationRecord Source #
Recorded location of a worker.
See: locationRecord
smart constructor.
locationRecord :: LocationRecord Source #
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:
lrLatitude :: Lens' LocationRecord (Maybe Double) Source #
Latitude.
lrConfidenceRadius :: Lens' LocationRecord (Maybe Double) Source #
The location accuracy in meters. This is the radius of a 95% confidence interval around the location measurement.
lrLongitude :: Lens' LocationRecord (Maybe Double) Source #
Longitude.
lrCollectionTime :: Lens' LocationRecord (Maybe Int64) Source #
The collection time in milliseconds since the epoch.
Worker
A worker in a Coordinate team.
See: worker
smart constructor.
wId :: Lens' Worker (Maybe Text) Source #
Worker email address. If a worker has been deleted from your team, the email address will appear as DELETED_USER.
CustomField
data CustomField Source #
Custom field.
See: customField
smart constructor.
customField :: CustomField Source #
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) Source #
Custom field id.
EnumItemDef
data EnumItemDef Source #
Enum Item definition.
See: enumItemDef
smart constructor.
enumItemDef :: EnumItemDef Source #
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: