gogol-maps-coordinate-0.0.1: Google Maps Coordinate SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.MapsCoordinate.Types

Contents

Description

 

Synopsis

Service Configuration

mapsCoordinateService :: Service 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 :: OAuthScope Source

View and manage your Google Maps Coordinate jobs

coordinateReadonlyScope :: OAuthScope Source

View your Google Coordinate jobs

LocationListResponse

data LocationListResponse Source

Response from a List Locations request.

See: locationListResponse smart constructor.

Instances

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.

llrKind :: Lens' LocationListResponse Text Source

Identifies this object as a list of locations.

llrItems :: Lens' LocationListResponse [LocationRecord] Source

Locations in the collection.

JobsPatchProgress

data JobsPatchProgress Source

Job progress

Constructors

Completed

COMPLETED Completed

InProgress

IN_PROGRESS In progress

NotAccepted

NOT_ACCEPTED Not accepted

NotStarted

NOT_STARTED Not started

Obsolete

OBSOLETE Obsolete

Instances

TokenPagination

data TokenPagination Source

Pagination information.

See: tokenPagination smart constructor.

Instances

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.

tpKind :: Lens' TokenPagination Text Source

Identifies this object as pagination information.

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.

Instances

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:

wlrKind :: Lens' WorkerListResponse Text Source

Identifies this object as a list of workers.

wlrItems :: Lens' WorkerListResponse [Worker] Source

Workers in the collection.

Schedule

data Schedule Source

Job schedule.

See: schedule smart constructor.

Instances

schedule :: Schedule Source

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

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

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.

sKind :: Lens' Schedule Text Source

Identifies this object as a job schedule.

sEndTime :: Lens' Schedule (Maybe Word64) Source

Scheduled end time in milliseconds since epoch.

sDuration :: Lens' Schedule (Maybe Word64) Source

Job duration in milliseconds.

Location

data Location Source

Location of a job.

See: location smart constructor.

Instances

location :: Location Source

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] Source

Address.

lKind :: Lens' Location Text Source

Identifies this object as a location.

lLat :: Lens' Location (Maybe Double) Source

Latitude.

lLng :: Lens' Location (Maybe Double) Source

Longitude.

JobsUpdateProgress

data JobsUpdateProgress Source

Job progress

Constructors

JUPCompleted

COMPLETED Completed

JUPInProgress

IN_PROGRESS In progress

JUPNotAccepted

NOT_ACCEPTED Not accepted

JUPNotStarted

NOT_STARTED Not started

JUPObsolete

OBSOLETE Obsolete

Instances

JobState

data JobState Source

Current state of a job.

See: jobState smart constructor.

Instances

jobState :: JobState Source

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:

jsLocation :: Lens' JobState (Maybe Location) Source

Job location.

jsProgress :: Lens' JobState (Maybe Text) Source

Job progress.

jsNote :: Lens' JobState [Text] Source

Note added to the job.

jsKind :: Lens' JobState Text Source

Identifies this object as a job state.

jsCustomerPhoneNumber :: Lens' JobState (Maybe Text) Source

Customer phone number.

jsCustomerName :: Lens' JobState (Maybe Text) Source

Customer name.

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.

jsTitle :: Lens' JobState (Maybe Text) Source

Job title.

CustomFieldDef

data CustomFieldDef Source

Custom field definition.

See: customFieldDef smart constructor.

Instances

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.

cfdKind :: Lens' CustomFieldDef Text Source

Identifies this object as a custom field definition.

cfdName :: Lens' CustomFieldDef (Maybe Text) Source

Custom field name.

cfdRequiredForCheckout :: Lens' CustomFieldDef (Maybe Bool) Source

Whether the field is required for checkout.

cfdId :: Lens' CustomFieldDef (Maybe Int64) Source

Custom field id.

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.

cfdType :: Lens' CustomFieldDef (Maybe Text) Source

Custom field type.

JobListResponse

data JobListResponse Source

Response from a List Jobs request.

See: jobListResponse smart constructor.

Instances

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.

jlrKind :: Lens' JobListResponse Text Source

Identifies this object as a list of jobs.

jlrItems :: Lens' JobListResponse [Job] Source

Jobs in the collection.

JobChange

data JobChange Source

Change to a job. For example assigning the job to a different worker.

See: jobChange smart constructor.

Instances

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.

jcKind :: Lens' JobChange Text Source

Identifies this object as a job change.

jcTimestamp :: Lens' JobChange (Maybe Word64) Source

Time at which this change was applied.

TeamListResponse

data TeamListResponse Source

Response from a List Teams request.

See: teamListResponse smart constructor.

Instances

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:

tlrKind :: Lens' TeamListResponse Text Source

Identifies this object as a list of teams.

tlrItems :: Lens' TeamListResponse [Team] Source

Teams in the collection.

CustomFieldDefListResponse

data CustomFieldDefListResponse Source

Collection of custom field definitions for a team.

See: customFieldDefListResponse smart constructor.

Instances

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

data Job Source

A job.

See: job smart constructor.

Instances

job :: Job Source

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:

jState :: Lens' Job (Maybe JobState) Source

Current job state.

jKind :: Lens' Job Text Source

Identifies this object as a job.

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.

jId :: Lens' Job (Maybe Word64) Source

Job id.

CustomFields

data CustomFields Source

Collection of custom fields.

See: customFields smart constructor.

Instances

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:

cfKind :: Lens' CustomFields Text Source

Identifies this object as a collection of custom fields.

cfCustomField :: Lens' CustomFields [CustomField] Source

Collection of custom fields.

Team

data Team Source

A Coordinate team.

See: team smart constructor.

Instances

team :: Team Source

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

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

tKind :: Lens' Team Text Source

Identifies this object as a team.

tName :: Lens' Team (Maybe Text) Source

Team name

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.

Instances

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:

lrKind :: Lens' LocationRecord Text Source

Identifies this object as a location.

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

data Worker Source

A worker in a Coordinate team.

See: worker smart constructor.

Instances

worker :: Worker Source

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

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

wKind :: Lens' Worker Text Source

Identifies this object as a worker.

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.

Instances

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.

cKind :: Lens' CustomField Text Source

Identifies this object as a custom field.

cValue :: Lens' CustomField (Maybe Text) Source

Custom field value.

EnumItemDef

data EnumItemDef Source

Enum Item definition.

See: enumItemDef smart constructor.

Instances

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:

eidKind :: Lens' EnumItemDef Text Source

Identifies this object as an enum item definition.

eidValue :: Lens' EnumItemDef (Maybe Text) Source

Custom field value.

eidActive :: Lens' EnumItemDef (Maybe Bool) Source

Whether the enum item is active. Jobs may contain inactive enum values; however, setting an enum to an inactive value when creating or updating a job will result in a 500 error.