harvest-api-0.1.0: Bindings for Harvest API

Copyright© 2016 Stack Builders
LicenseMIT
MaintainerMark Karpov <mkarpov@stackbuilders.com>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Web.Harvest.API.Type

Description

Used types, they are re-exported in Web.Harvest.API, so you can import just that module.

Synopsis

Documentation

data Credentials Source

Information that is necessary for interaction with Harvest API.

Constructors

Credentials 

Fields

credentialsUsername :: ByteString

Username

credentialsPassword :: ByteString

Password

credentialsAccount :: ByteString

Account (name of your organization)

newtype UserId Source

User identifier.

Constructors

UserId 

Fields

unUserId :: Word
 

data User Source

User record.

Constructors

User 

Fields

userId :: UserId

User id

userEmail :: Text

Email address

userCreatedAt :: UTCTime

When the user was created

userIsAdmin :: Bool

Is the user admin?

userFirstName :: Text

The user's first name

userLastName :: Text

The user's last name

userTimeZone :: Text

The user's time zone (Text for now)

userIsContractor :: Bool

Is the user contractor?

userTelephone :: Text

User's telephone

userIsActive :: Bool

Is it an active user?

userAccessFuture :: Bool

Does he/she have access to all future projects?

userDefaultHourlyRate :: Word

Default hourly rate

userDepartment :: Maybe Text

User's department

userWantsNewsletter :: Bool

Does he/she want to recieve newsletter?

userUpdatedAt :: UTCTime

Time of last update of account

userCostRate :: Maybe Word

User's cost rate

userIdentityAccountId :: Maybe Word

Identity account id

userIdentityUserId :: Maybe Word

Identity user id

data TimeEntries Source

Collection of entries for specific day.

Constructors

TimeEntries 

Fields

teForDay :: Day

That collection is for this day

teDayEntries :: [TimeEntry]

Collection of time entries

data TimeEntry Source

A time entry.

Constructors

TimeEntry 

Fields

teProjectId :: Text

Project id

teProject :: Text

Project

teUserId :: UserId

User id

teSpentAt :: Day

The day this time is spent on

teTaskId :: Text

Task id

teTask :: Text

Task name

teClient :: Text

Client name

teId :: TimeEntryId

Time entry id

teNotes :: Maybe Text

Notes

teTimerStartedAt :: Maybe UTCTime

When the task was started, if Nothing — timer is not running

teCreatedAt :: UTCTime

When the task was created

teUpdatedAt :: UTCTime

When the task was updated

teHoursWithoutTimer :: Double

Hours without timer

teHours :: Double

Hours