Strive.Options

Optional parameters for actions.

Documentation

data PaginationOptions

Constructors

PaginationOptions

Fields

paginationOptions_page :: Integer

paginationOptions_perPage :: Integer

Instances

Show PaginationOptions

Default PaginationOptions

QueryLike PaginationOptions

PerPageLens PaginationOptions Integer

PageLens PaginationOptions Integer

Authentication

data BuildAuthorizeUrlOptions

buildAuthorizeUrl

Constructors

BuildAuthorizeUrlOptions

Fields

buildAuthorizeUrlOptions_approvalPrompt :: Bool

buildAuthorizeUrlOptions_privateScope :: Bool

buildAuthorizeUrlOptions_writeScope :: Bool

buildAuthorizeUrlOptions_state :: String

Instances

Show BuildAuthorizeUrlOptions

Default BuildAuthorizeUrlOptions

QueryLike BuildAuthorizeUrlOptions

WriteScopeLens BuildAuthorizeUrlOptions Bool

StateLens BuildAuthorizeUrlOptions String

PrivateScopeLens BuildAuthorizeUrlOptions Bool

ApprovalPromptLens BuildAuthorizeUrlOptions Bool

Athletes

data UpdateCurrentAthleteOptions

updateCurrentAthlete

Constructors

UpdateCurrentAthleteOptions

Fields

updateCurrentAthleteOptions_city :: Maybe String

updateCurrentAthleteOptions_state :: Maybe String

updateCurrentAthleteOptions_country :: Maybe String

updateCurrentAthleteOptions_sex :: Maybe Char

updateCurrentAthleteOptions_weight :: Maybe Double

Instances

Show UpdateCurrentAthleteOptions

Default UpdateCurrentAthleteOptions

QueryLike UpdateCurrentAthleteOptions

WeightLens UpdateCurrentAthleteOptions (Maybe Double)

StateLens UpdateCurrentAthleteOptions (Maybe String)

SexLens UpdateCurrentAthleteOptions (Maybe Char)

CountryLens UpdateCurrentAthleteOptions (Maybe String)

CityLens UpdateCurrentAthleteOptions (Maybe String)

type GetAthleteCrsOptions = PaginationOptions

getAthleteCrs

Friends and Followers

type GetCurrentFriendsOptions = PaginationOptions

getCurrentFriends

type GetFriendsOptions = PaginationOptions

getFriends

type GetCurrentFollowersOptions = PaginationOptions

getCurrentFollowers

type GetFollowersOptions = PaginationOptions

getFollowers

type GetCommonFriendsOptions = PaginationOptions

getCommonFriends

Activities

data CreateActivityOptions

CreateActivity

Constructors

CreateActivityOptions

Fields

createActivityOptions_description :: Maybe String

createActivityOptions_distance :: Maybe Double

Instances

Show CreateActivityOptions

Default CreateActivityOptions

QueryLike CreateActivityOptions

DistanceLens CreateActivityOptions (Maybe Double)

DescriptionLens CreateActivityOptions (Maybe String)

data GetActivityOptions

GetActivity

Constructors

GetActivityOptions

Fields

getActivityOptions_allEfforts :: Bool

Instances

Show GetActivityOptions

Default GetActivityOptions

QueryLike GetActivityOptions

AllEffortsLens GetActivityOptions Bool

data UpdateActivityOptions

UpdateActivity

Constructors

UpdateActivityOptions

Fields

updateActivityOptions_name :: Maybe String

updateActivityOptions_type :: Maybe String

updateActivityOptions_private :: Maybe Bool

updateActivityOptions_commute :: Maybe Bool

updateActivityOptions_trainer :: Maybe Bool

updateActivityOptions_gearId :: Maybe String

updateActivityOptions_description :: Maybe String

Instances

Show UpdateActivityOptions

Default UpdateActivityOptions

QueryLike UpdateActivityOptions

TypeLens UpdateActivityOptions (Maybe String)

TrainerLens UpdateActivityOptions (Maybe Bool)

PrivateLens UpdateActivityOptions (Maybe Bool)

NameLens UpdateActivityOptions (Maybe String)

GearIdLens UpdateActivityOptions (Maybe String)

DescriptionLens UpdateActivityOptions (Maybe String)

CommuteLens UpdateActivityOptions (Maybe Bool)

data GetCurrentActivitiesOptions

getCurrentActivities

Constructors

GetCurrentActivitiesOptions

Fields

getCurrentActivitiesOptions_before :: Maybe UTCTime

getCurrentActivitiesOptions_after :: Maybe UTCTime

getCurrentActivitiesOptions_page :: Integer

getCurrentActivitiesOptions_perPage :: Integer

Instances

Show GetCurrentActivitiesOptions

Default GetCurrentActivitiesOptions

QueryLike GetCurrentActivitiesOptions

PerPageLens GetCurrentActivitiesOptions Integer

PageLens GetCurrentActivitiesOptions Integer

BeforeLens GetCurrentActivitiesOptions (Maybe UTCTime)

AfterLens GetCurrentActivitiesOptions (Maybe UTCTime)

type GetFeedOptions = PaginationOptions

getFeed

Comments

data GetActivityCommentsOptions

getActivityComments

Constructors

GetActivityCommentsOptions

Fields

getActivityCommentsOptions_markdown :: Bool

getActivityCommentsOptions_page :: Integer

getActivityCommentsOptions_perPage :: Integer

Instances

Show GetActivityCommentsOptions

Default GetActivityCommentsOptions

QueryLike GetActivityCommentsOptions

PerPageLens GetActivityCommentsOptions Integer

PageLens GetActivityCommentsOptions Integer

MarkdownLens GetActivityCommentsOptions Bool

Kudos

type GetActivityKudoersOptions = PaginationOptions

getActivityKudoers

Clubs

type GetClubMembersOptions = PaginationOptions

getClubMembers

type GetClubActivitiesOptions = PaginationOptions

getClubActivities

type GetStarredSegmentsOptions = PaginationOptions

getStarredSegments

data GetSegmentEffortsOptions

getSegmentEfforts

Constructors

GetSegmentEffortsOptions

Fields

getSegmentEffortsOptions_athleteId :: Maybe Integer

getSegmentEffortsOptions_range :: Maybe (UTCTime, UTCTime)

getSegmentEffortsOptions_page :: Integer

getSegmentEffortsOptions_perPage :: Integer

Instances

Show GetSegmentEffortsOptions

Default GetSegmentEffortsOptions

QueryLike GetSegmentEffortsOptions

PerPageLens GetSegmentEffortsOptions Integer

PageLens GetSegmentEffortsOptions Integer

RangeLens GetSegmentEffortsOptions (Maybe (UTCTime, UTCTime))

AthleteIdLens GetSegmentEffortsOptions (Maybe Integer)

data GetSegmentLeaderboardOptions

getSegmentLeaderboard

Constructors

GetSegmentLeaderboardOptions

Fields

getSegmentLeaderboard_gender :: Maybe Char

getSegmentLeaderboard_ageGroup :: Maybe String

getSegmentLeaderboard_weightClass :: Maybe String

getSegmentLeaderboard_following :: Maybe Bool

getSegmentLeaderboard_clubId :: Maybe Integer

getSegmentLeaderboard_dateRange :: Maybe String

getSegmentLeaderboard_page :: Integer

getSegmentLeaderboard_perPage :: Integer

Instances

Show GetSegmentLeaderboardOptions

Default GetSegmentLeaderboardOptions

QueryLike GetSegmentLeaderboardOptions

PerPageLens GetSegmentLeaderboardOptions Integer

PageLens GetSegmentLeaderboardOptions Integer

WeightClassLens GetSegmentLeaderboardOptions (Maybe String)

GenderLens GetSegmentLeaderboardOptions (Maybe Char)

FollowingLens GetSegmentLeaderboardOptions (Maybe Bool)

DateRangeLens GetSegmentLeaderboardOptions (Maybe String)

ClubIdLens GetSegmentLeaderboardOptions (Maybe Integer)

AgeGroupLens GetSegmentLeaderboardOptions (Maybe String)

data ExploreSegmentsOptions

exploreSegments

Constructors

ExploreSegmentsOptions

Fields

exploreSegmentsOptions_activityType :: String

exploreSegmentsOptions_minCat :: Integer

exploreSegmentsOptions_maxCat :: Integer

Instances

Show ExploreSegmentsOptions

Default ExploreSegmentsOptions

QueryLike ExploreSegmentsOptions

MinCatLens ExploreSegmentsOptions Integer

MaxCatLens ExploreSegmentsOptions Integer

ActivityTypeLens ExploreSegmentsOptions String

Streams

data GetStreamsOptions

getStreams

Constructors

GetStreamsOptions

Fields

getStreamsOptions_resolution :: Maybe String

getStreamsOptions_seriesType :: String

Instances

Show GetStreamsOptions

Default GetStreamsOptions

QueryLike GetStreamsOptions

SeriesTypeLens GetStreamsOptions String

ResolutionLens GetStreamsOptions (Maybe String)

Uploads

data UploadActivityOptions

uploadActivity

Constructors

UploadActivityOptions

Fields

uploadActivityOptions_activityType :: Maybe String

uploadActivityOptions_name :: Maybe String

uploadActivityOptions_description :: Maybe String

uploadActivityOptions_private :: Bool

uploadActivityOptions_trainer :: Bool

uploadActivityOptions_externalId :: Maybe String

Instances

Show UploadActivityOptions

Default UploadActivityOptions

QueryLike UploadActivityOptions

TrainerLens UploadActivityOptions Bool

PrivateLens UploadActivityOptions Bool

NameLens UploadActivityOptions (Maybe String)

ExternalIdLens UploadActivityOptions (Maybe String)

DescriptionLens UploadActivityOptions (Maybe String)

ActivityTypeLens UploadActivityOptions (Maybe String)