Vikunja.Core

VikunjaConfig

data VikunjaConfig

Constructors

VikunjaConfig

Fields

• configHost :: ByteString

  host supplied in the Request

• configUserAgent :: Text

  user-agent supplied in the Request

• configLogExecWithContext :: LogExecWithContext

  Run a block using a Logger instance

• configLogContext :: LogContext

  Configures the logger

• configAuthMethods :: [AnyAuthMethod]

  List of configured auth methods

• configValidateAuthMethods :: Bool

  throw exceptions if auth methods are not configured

• configQueryExtraUnreserved :: ByteString

  Configures additional querystring characters which must not be URI encoded, e.g. + or :

Instances

Show VikunjaConfig

display the config

Defined in Vikunja.Core

Methods

showsPrec :: Int -> VikunjaConfig -> ShowS

show :: VikunjaConfig -> String

showList :: [VikunjaConfig] -> ShowS

newConfig :: IO VikunjaConfig

constructs a default VikunjaConfig

configHost:

apiv1

configUserAgent:

"vikunja-api/0.24.6.0"

addAuthMethod :: AuthMethod auth => VikunjaConfig -> auth -> VikunjaConfig

updates config use AuthMethod on matching requests

withStdoutLogging :: VikunjaConfig -> IO VikunjaConfig

updates the config to use stdout logging

withStderrLogging :: VikunjaConfig -> IO VikunjaConfig

updates the config to use stderr logging

withNoLogging :: VikunjaConfig -> VikunjaConfig

updates the config to disable logging

VikunjaRequest

data VikunjaRequest req contentType res accept

Represents a request.

Type Variables:

• req - request operation
• contentType - MimeType associated with request body
• res - response model
• accept - MimeType associated with response body

Constructors

VikunjaRequest

Fields

• rMethod :: Method

  Method of VikunjaRequest

• rUrlPath :: [ByteString]

  Endpoint of VikunjaRequest

• rParams :: Params

  params of VikunjaRequest

• rAuthTypes :: [TypeRep]

  types of auth methods

Instances

Show (VikunjaRequest req contentType res accept)

Defined in Vikunja.Core

Methods

showsPrec :: Int -> VikunjaRequest req contentType res accept -> ShowS

show :: VikunjaRequest req contentType res accept -> String

showList :: [VikunjaRequest req contentType res accept] -> ShowS

rMethodL :: Lens_' (VikunjaRequest req contentType res accept) Method

rMethod Lens

rUrlPathL :: Lens_' (VikunjaRequest req contentType res accept) [ByteString]

rUrlPath Lens

rParamsL :: Lens_' (VikunjaRequest req contentType res accept) Params

rParams Lens

rAuthTypesL :: Lens_' (VikunjaRequest req contentType res accept) [TypeRep]

rParams Lens

HasBodyParam

class HasBodyParam req param where

Designates the body parameter of a request

Minimal complete definition

Nothing

Methods

setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => VikunjaRequest req contentType res accept -> param -> VikunjaRequest req contentType res accept

Instances

HasBodyParam ProjectsIdWebhooksPut ModelsWebhook

Body Param "webhook" - The webhook target object with required fields

Defined in Vikunja.API.Webhooks

Methods

setBodyParam :: (Consumes ProjectsIdWebhooksPut contentType, MimeRender contentType ModelsWebhook) => VikunjaRequest ProjectsIdWebhooksPut contentType res accept -> ModelsWebhook -> VikunjaRequest ProjectsIdWebhooksPut contentType res accept

HasBodyParam UserSettingsTotpEnablePost UserTOTPPasscode

Body Param "totp" - The totp passcode.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserSettingsTotpEnablePost contentType, MimeRender contentType UserTOTPPasscode) => VikunjaRequest UserSettingsTotpEnablePost contentType res accept -> UserTOTPPasscode -> VikunjaRequest UserSettingsTotpEnablePost contentType res accept

HasBodyParam UserSettingsTotpDisablePost UserLogin

Body Param "totp" - The current user's password (only password is enough).

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserSettingsTotpDisablePost contentType, MimeRender contentType UserLogin) => VikunjaRequest UserSettingsTotpDisablePost contentType res accept -> UserLogin -> VikunjaRequest UserSettingsTotpDisablePost contentType res accept

HasBodyParam UserSettingsGeneralPost V1UserSettings

Body Param "avatar" - The updated user settings

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserSettingsGeneralPost contentType, MimeRender contentType V1UserSettings) => VikunjaRequest UserSettingsGeneralPost contentType res accept -> V1UserSettings -> VikunjaRequest UserSettingsGeneralPost contentType res accept

HasBodyParam UserSettingsEmailPost UserEmailUpdate

Body Param "userEmailUpdate" - The new email address and current password.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserSettingsEmailPost contentType, MimeRender contentType UserEmailUpdate) => VikunjaRequest UserSettingsEmailPost contentType res accept -> UserEmailUpdate -> VikunjaRequest UserSettingsEmailPost contentType res accept

HasBodyParam UserSettingsAvatarPost V1UserAvatarProvider

Body Param "avatar" - The user's avatar setting

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserSettingsAvatarPost contentType, MimeRender contentType V1UserAvatarProvider) => VikunjaRequest UserSettingsAvatarPost contentType res accept -> V1UserAvatarProvider -> VikunjaRequest UserSettingsAvatarPost contentType res accept

HasBodyParam UserPasswordTokenPost UserPasswordTokenRequest

Body Param "credentials" - The username of the user to request a token for.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserPasswordTokenPost contentType, MimeRender contentType UserPasswordTokenRequest) => VikunjaRequest UserPasswordTokenPost contentType res accept -> UserPasswordTokenRequest -> VikunjaRequest UserPasswordTokenPost contentType res accept

HasBodyParam UserPasswordResetPost UserPasswordReset

Body Param "credentials" - The token with the new password.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserPasswordResetPost contentType, MimeRender contentType UserPasswordReset) => VikunjaRequest UserPasswordResetPost contentType res accept -> UserPasswordReset -> VikunjaRequest UserPasswordResetPost contentType res accept

HasBodyParam UserPasswordPost V1UserPassword

Body Param "userPassword" - The current and new password.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserPasswordPost contentType, MimeRender contentType V1UserPassword) => VikunjaRequest UserPasswordPost contentType res accept -> V1UserPassword -> VikunjaRequest UserPasswordPost contentType res accept

HasBodyParam UserExportRequestPost V1UserPasswordConfirmation

Body Param "password" - User password to confirm the data export request.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserExportRequestPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserExportRequestPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserExportRequestPost contentType res accept

HasBodyParam UserExportDownloadPost V1UserPasswordConfirmation

Body Param "password" - User password to confirm the download.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserExportDownloadPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserExportDownloadPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserExportDownloadPost contentType res accept

HasBodyParam UserDeletionRequestPost V1UserPasswordConfirmation

Body Param "credentials" - The user password.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserDeletionRequestPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserDeletionRequestPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserDeletionRequestPost contentType res accept

HasBodyParam UserDeletionConfirmPost V1UserDeletionRequestConfirm

Body Param "credentials" - The token.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserDeletionConfirmPost contentType, MimeRender contentType V1UserDeletionRequestConfirm) => VikunjaRequest UserDeletionConfirmPost contentType res accept -> V1UserDeletionRequestConfirm -> VikunjaRequest UserDeletionConfirmPost contentType res accept

HasBodyParam UserDeletionCancelPost V1UserPasswordConfirmation

Body Param "credentials" - The user password to confirm.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserDeletionCancelPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserDeletionCancelPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserDeletionCancelPost contentType res accept

HasBodyParam UserConfirmPost UserEmailConfirm

Body Param "credentials" - The token.

Defined in Vikunja.API.User

Methods

setBodyParam :: (Consumes UserConfirmPost contentType, MimeRender contentType UserEmailConfirm) => VikunjaRequest UserConfirmPost contentType res accept -> UserEmailConfirm -> VikunjaRequest UserConfirmPost contentType res accept

HasBodyParam TeamsPut ModelsTeam

Body Param "team" - The team you want to create.

Defined in Vikunja.API.Team

Methods

setBodyParam :: (Consumes TeamsPut contentType, MimeRender contentType ModelsTeam) => VikunjaRequest TeamsPut contentType res accept -> ModelsTeam -> VikunjaRequest TeamsPut contentType res accept

HasBodyParam TeamsIdPost ModelsTeam

Body Param "team" - The team with updated values you want to update.

Defined in Vikunja.API.Team

Methods

setBodyParam :: (Consumes TeamsIdPost contentType, MimeRender contentType ModelsTeam) => VikunjaRequest TeamsIdPost contentType res accept -> ModelsTeam -> VikunjaRequest TeamsIdPost contentType res accept

HasBodyParam TeamsIdMembersPut ModelsTeamMember

Body Param "team" - The user to be added to a team.

Defined in Vikunja.API.Team

Methods

setBodyParam :: (Consumes TeamsIdMembersPut contentType, MimeRender contentType ModelsTeamMember) => VikunjaRequest TeamsIdMembersPut contentType res accept -> ModelsTeamMember -> VikunjaRequest TeamsIdMembersPut contentType res accept

HasBodyParam TasksTaskIDRelationsRelationKindOtherTaskIDDelete ModelsTaskRelation

Body Param "relation" - The relation object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksTaskIDRelationsRelationKindOtherTaskIDDelete contentType, MimeRender contentType ModelsTaskRelation) => VikunjaRequest TasksTaskIDRelationsRelationKindOtherTaskIDDelete contentType res accept -> ModelsTaskRelation -> VikunjaRequest TasksTaskIDRelationsRelationKindOtherTaskIDDelete contentType res accept

HasBodyParam TasksTaskIDRelationsPut ModelsTaskRelation

Body Param "relation" - The relation object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksTaskIDRelationsPut contentType, MimeRender contentType ModelsTaskRelation) => VikunjaRequest TasksTaskIDRelationsPut contentType res accept -> ModelsTaskRelation -> VikunjaRequest TasksTaskIDRelationsPut contentType res accept

HasBodyParam TasksTaskIDCommentsPut ModelsTaskComment

Body Param "relation" - The task comment object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksTaskIDCommentsPut contentType, MimeRender contentType ModelsTaskComment) => VikunjaRequest TasksTaskIDCommentsPut contentType res accept -> ModelsTaskComment -> VikunjaRequest TasksTaskIDCommentsPut contentType res accept

HasBodyParam TasksIdPost ModelsTask

Body Param "task" - The task object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksIdPost contentType, MimeRender contentType ModelsTask) => VikunjaRequest TasksIdPost contentType res accept -> ModelsTask -> VikunjaRequest TasksIdPost contentType res accept

HasBodyParam TasksIdPositionPost ModelsTaskPosition

Body Param "view" - The task position with updated values you want to change.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksIdPositionPost contentType, MimeRender contentType ModelsTaskPosition) => VikunjaRequest TasksIdPositionPost contentType res accept -> ModelsTaskPosition -> VikunjaRequest TasksIdPositionPost contentType res accept

HasBodyParam TasksBulkPost ModelsBulkTask

Body Param "task" - The task object. Looks like a normal task, the only difference is it uses an array of project_ids to update.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes TasksBulkPost contentType, MimeRender contentType ModelsBulkTask) => VikunjaRequest TasksBulkPost contentType res accept -> ModelsBulkTask -> VikunjaRequest TasksBulkPost contentType res accept

HasBodyParam ProjectsProjectViewsViewBucketsBucketTasksPost ModelsTaskBucket

Body Param "taskBucket" - The id of the task you want to move into the bucket.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes ProjectsProjectViewsViewBucketsBucketTasksPost contentType, MimeRender contentType ModelsTaskBucket) => VikunjaRequest ProjectsProjectViewsViewBucketsBucketTasksPost contentType res accept -> ModelsTaskBucket -> VikunjaRequest ProjectsProjectViewsViewBucketsBucketTasksPost contentType res accept

HasBodyParam ProjectsIdTasksPut ModelsTask

Body Param "task" - The task object

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes ProjectsIdTasksPut contentType, MimeRender contentType ModelsTask) => VikunjaRequest ProjectsIdTasksPut contentType res accept -> ModelsTask -> VikunjaRequest ProjectsIdTasksPut contentType res accept

HasBodyParam KindIdReactionsPut ModelsReaction

Body Param "project" - The reaction you want to add to the entity.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes KindIdReactionsPut contentType, MimeRender contentType ModelsReaction) => VikunjaRequest KindIdReactionsPut contentType res accept -> ModelsReaction -> VikunjaRequest KindIdReactionsPut contentType res accept

HasBodyParam KindIdReactionsDeletePost ModelsReaction

Body Param "project" - The reaction you want to add to the entity.

Defined in Vikunja.API.Task

Methods

setBodyParam :: (Consumes KindIdReactionsDeletePost contentType, MimeRender contentType ModelsReaction) => VikunjaRequest KindIdReactionsDeletePost contentType res accept -> ModelsReaction -> VikunjaRequest KindIdReactionsDeletePost contentType res accept

HasBodyParam SharesShareAuthPost V1LinkShareAuth

Body Param "password" - The password for link shares which require one.

Defined in Vikunja.API.Sharing

Methods

setBodyParam :: (Consumes SharesShareAuthPost contentType, MimeRender contentType V1LinkShareAuth) => VikunjaRequest SharesShareAuthPost contentType res accept -> V1LinkShareAuth -> VikunjaRequest SharesShareAuthPost contentType res accept

HasBodyParam ProjectsProjectSharesPut ModelsLinkSharing

Body Param "label" - The new link share object

Defined in Vikunja.API.Sharing

Methods

setBodyParam :: (Consumes ProjectsProjectSharesPut contentType, MimeRender contentType ModelsLinkSharing) => VikunjaRequest ProjectsProjectSharesPut contentType res accept -> ModelsLinkSharing -> VikunjaRequest ProjectsProjectSharesPut contentType res accept

HasBodyParam ProjectsProjectIDUsersUserIDPost ModelsProjectUser

Body Param "project" - The user you want to update.

Defined in Vikunja.API.Sharing

Methods

setBodyParam :: (Consumes ProjectsProjectIDUsersUserIDPost contentType, MimeRender contentType ModelsProjectUser) => VikunjaRequest ProjectsProjectIDUsersUserIDPost contentType res accept -> ModelsProjectUser -> VikunjaRequest ProjectsProjectIDUsersUserIDPost contentType res accept

HasBodyParam ProjectsProjectIDTeamsTeamIDPost ModelsTeamProject

Body Param "project" - The team you want to update.

Defined in Vikunja.API.Sharing

Methods

setBodyParam :: (Consumes ProjectsProjectIDTeamsTeamIDPost contentType, MimeRender contentType ModelsTeamProject) => VikunjaRequest ProjectsProjectIDTeamsTeamIDPost contentType res accept -> ModelsTeamProject -> VikunjaRequest ProjectsProjectIDTeamsTeamIDPost contentType res accept

HasBodyParam ProjectsIdUsersPut ModelsProjectUser

Body Param "project" - The user you want to add to the project.

Defined in Vikunja.API.Sharing

Methods

setBodyParam :: (Consumes ProjectsIdUsersPut contentType, MimeRender contentType ModelsProjectUser) => VikunjaRequest ProjectsIdUsersPut contentType res accept -> ModelsProjectUser -> VikunjaRequest ProjectsIdUsersPut contentType res accept

HasBodyParam ProjectsIdTeamsPut ModelsTeamProject

Body Param "project" - The team you want to add to the project.

Defined in Vikunja.API.Sharing

Methods

setBodyParam :: (Consumes ProjectsIdTeamsPut contentType, MimeRender contentType ModelsTeamProject) => VikunjaRequest ProjectsIdTeamsPut contentType res accept -> ModelsTeamProject -> VikunjaRequest ProjectsIdTeamsPut contentType res accept

HasBodyParam ProjectsPut ModelsProject

Body Param "project" - The project you want to create.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsPut contentType, MimeRender contentType ModelsProject) => VikunjaRequest ProjectsPut contentType res accept -> ModelsProject -> VikunjaRequest ProjectsPut contentType res accept

HasBodyParam ProjectsProjectViewsPut ModelsProjectView

Body Param "view" - The project view you want to create.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectViewsPut contentType, MimeRender contentType ModelsProjectView) => VikunjaRequest ProjectsProjectViewsPut contentType res accept -> ModelsProjectView -> VikunjaRequest ProjectsProjectViewsPut contentType res accept

HasBodyParam ProjectsProjectViewsIdPost ModelsProjectView

Body Param "view" - The project view with updated values you want to change.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectViewsIdPost contentType, MimeRender contentType ModelsProjectView) => VikunjaRequest ProjectsProjectViewsIdPost contentType res accept -> ModelsProjectView -> VikunjaRequest ProjectsProjectViewsIdPost contentType res accept

HasBodyParam ProjectsProjectIDViewsViewBucketsBucketIDPost ModelsBucket

Body Param "bucket" - The bucket object

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectIDViewsViewBucketsBucketIDPost contentType, MimeRender contentType ModelsBucket) => VikunjaRequest ProjectsProjectIDViewsViewBucketsBucketIDPost contentType res accept -> ModelsBucket -> VikunjaRequest ProjectsProjectIDViewsViewBucketsBucketIDPost contentType res accept

HasBodyParam ProjectsProjectIDDuplicatePut ModelsProjectDuplicate

Body Param "project" - The target parent project which should hold the copied project.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsProjectIDDuplicatePut contentType, MimeRender contentType ModelsProjectDuplicate) => VikunjaRequest ProjectsProjectIDDuplicatePut contentType res accept -> ModelsProjectDuplicate -> VikunjaRequest ProjectsProjectIDDuplicatePut contentType res accept

HasBodyParam ProjectsIdViewsViewBucketsPut ModelsBucket

Body Param "bucket" - The bucket object

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsIdViewsViewBucketsPut contentType, MimeRender contentType ModelsBucket) => VikunjaRequest ProjectsIdViewsViewBucketsPut contentType res accept -> ModelsBucket -> VikunjaRequest ProjectsIdViewsViewBucketsPut contentType res accept

HasBodyParam ProjectsIdPost ModelsProject

Body Param "project" - The project with updated values you want to update.

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsIdPost contentType, MimeRender contentType ModelsProject) => VikunjaRequest ProjectsIdPost contentType res accept -> ModelsProject -> VikunjaRequest ProjectsIdPost contentType res accept

HasBodyParam ProjectsIdBackgroundsUnsplashPost BackgroundImage

Body Param "project" - The image you want to set as background

Defined in Vikunja.API.Project

Methods

setBodyParam :: (Consumes ProjectsIdBackgroundsUnsplashPost contentType, MimeRender contentType BackgroundImage) => VikunjaRequest ProjectsIdBackgroundsUnsplashPost contentType res accept -> BackgroundImage -> VikunjaRequest ProjectsIdBackgroundsUnsplashPost contentType res accept

HasBodyParam MigrationTrelloMigratePost TrelloMigration

Body Param "migrationCode" - The auth token previously obtained from the auth url. See the docs for migrationtrello/auth.

Defined in Vikunja.API.Migration

Methods

setBodyParam :: (Consumes MigrationTrelloMigratePost contentType, MimeRender contentType TrelloMigration) => VikunjaRequest MigrationTrelloMigratePost contentType res accept -> TrelloMigration -> VikunjaRequest MigrationTrelloMigratePost contentType res accept

HasBodyParam MigrationTodoistMigratePost TodoistMigration

Body Param "migrationCode" - The auth code previously obtained from the auth url. See the docs for migrationtodoist/auth.

Defined in Vikunja.API.Migration

Methods

setBodyParam :: (Consumes MigrationTodoistMigratePost contentType, MimeRender contentType TodoistMigration) => VikunjaRequest MigrationTodoistMigratePost contentType res accept -> TodoistMigration -> VikunjaRequest MigrationTodoistMigratePost contentType res accept

HasBodyParam MigrationMicrosoftTodoMigratePost MicrosofttodoMigration

Body Param "migrationCode" - The auth token previously obtained from the auth url. See the docs for migrationmicrosoft-todo/auth.

Defined in Vikunja.API.Migration

Methods

setBodyParam :: (Consumes MigrationMicrosoftTodoMigratePost contentType, MimeRender contentType MicrosofttodoMigration) => VikunjaRequest MigrationMicrosoftTodoMigratePost contentType res accept -> MicrosofttodoMigration -> VikunjaRequest MigrationMicrosoftTodoMigratePost contentType res accept

HasBodyParam TasksTaskLabelsPut ModelsLabelTask

Body Param "label" - The label object

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes TasksTaskLabelsPut contentType, MimeRender contentType ModelsLabelTask) => VikunjaRequest TasksTaskLabelsPut contentType res accept -> ModelsLabelTask -> VikunjaRequest TasksTaskLabelsPut contentType res accept

HasBodyParam TasksTaskIDLabelsBulkPost ModelsLabelTaskBulk

Body Param "label" - The array of labels

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes TasksTaskIDLabelsBulkPost contentType, MimeRender contentType ModelsLabelTaskBulk) => VikunjaRequest TasksTaskIDLabelsBulkPost contentType res accept -> ModelsLabelTaskBulk -> VikunjaRequest TasksTaskIDLabelsBulkPost contentType res accept

HasBodyParam LabelsPut ModelsLabel

Body Param "label" - The label object

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes LabelsPut contentType, MimeRender contentType ModelsLabel) => VikunjaRequest LabelsPut contentType res accept -> ModelsLabel -> VikunjaRequest LabelsPut contentType res accept

HasBodyParam LabelsIdPut ModelsLabel

Body Param "label" - The label object

Defined in Vikunja.API.Labels

Methods

setBodyParam :: (Consumes LabelsIdPut contentType, MimeRender contentType ModelsLabel) => VikunjaRequest LabelsIdPut contentType res accept -> ModelsLabel -> VikunjaRequest LabelsIdPut contentType res accept

HasBodyParam RegisterPost UserAPIUserPassword

Body Param "credentials" - The user credentials

Defined in Vikunja.API.Auth

Methods

setBodyParam :: (Consumes RegisterPost contentType, MimeRender contentType UserAPIUserPassword) => VikunjaRequest RegisterPost contentType res accept -> UserAPIUserPassword -> VikunjaRequest RegisterPost contentType res accept

HasBodyParam LoginPost UserLogin

Body Param "credentials" - The login credentials

Defined in Vikunja.API.Auth

Methods

setBodyParam :: (Consumes LoginPost contentType, MimeRender contentType UserLogin) => VikunjaRequest LoginPost contentType res accept -> UserLogin -> VikunjaRequest LoginPost contentType res accept

HasBodyParam GetTokenOpenid OpenidCallback

Body Param "callback" - The openid callback

Defined in Vikunja.API.Auth

Methods

setBodyParam :: (Consumes GetTokenOpenid contentType, MimeRender contentType OpenidCallback) => VikunjaRequest GetTokenOpenid contentType res accept -> OpenidCallback -> VikunjaRequest GetTokenOpenid contentType res accept

HasBodyParam TasksTaskIDAssigneesPut ModelsTaskAssginee

Body Param "assignee" - The assingee object

Defined in Vikunja.API.Assignees

Methods

setBodyParam :: (Consumes TasksTaskIDAssigneesPut contentType, MimeRender contentType ModelsTaskAssginee) => VikunjaRequest TasksTaskIDAssigneesPut contentType res accept -> ModelsTaskAssginee -> VikunjaRequest TasksTaskIDAssigneesPut contentType res accept

HasBodyParam TasksTaskIDAssigneesBulkPost ModelsBulkAssignees

Body Param "assignee" - The array of assignees

Defined in Vikunja.API.Assignees

Methods

setBodyParam :: (Consumes TasksTaskIDAssigneesBulkPost contentType, MimeRender contentType ModelsBulkAssignees) => VikunjaRequest TasksTaskIDAssigneesBulkPost contentType res accept -> ModelsBulkAssignees -> VikunjaRequest TasksTaskIDAssigneesBulkPost contentType res accept

HasBodyParam TokensPut ModelsAPIToken

Body Param "token" - The token object with required fields

Defined in Vikunja.API.Api

Methods

setBodyParam :: (Consumes TokensPut contentType, MimeRender contentType ModelsAPIToken) => VikunjaRequest TokensPut contentType res accept -> ModelsAPIToken -> VikunjaRequest TokensPut contentType res accept

HasOptionalParam

class HasOptionalParam req param where

Designates the optional parameters of a request

Minimal complete definition

applyOptionalParam | (-&-)

Methods

applyOptionalParam :: VikunjaRequest req contentType res accept -> param -> VikunjaRequest req contentType res accept

Apply an optional parameter to a request

(-&-) :: VikunjaRequest req contentType res accept -> param -> VikunjaRequest req contentType res accept infixl 2

infix operator / alias for addOptionalParam

Instances

HasOptionalParam ProjectsIdWebhooksGet PerPage

Optional Param "per_page" - The maximum number of items per bucket per page. This parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Webhooks

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

HasOptionalParam ProjectsIdWebhooksGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Webhooks

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdWebhooksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdWebhooksGet contentType res accept

HasOptionalParam UsersGet S

Optional Param "s" - The search criteria.

Defined in Vikunja.API.User

Methods

applyOptionalParam :: VikunjaRequest UsersGet contentType res accept -> S -> VikunjaRequest UsersGet contentType res accept

(-&-) :: VikunjaRequest UsersGet contentType res accept -> S -> VikunjaRequest UsersGet contentType res accept

HasOptionalParam UsernameAvatarGet Size

Optional Param "size" - The size of the avatar you want to get. If bigger than the max configured size this will be adjusted to the maximum size.

Defined in Vikunja.API.User

Methods

applyOptionalParam :: VikunjaRequest UsernameAvatarGet contentType res accept -> Size -> VikunjaRequest UsernameAvatarGet contentType res accept

(-&-) :: VikunjaRequest UsernameAvatarGet contentType res accept -> Size -> VikunjaRequest UsernameAvatarGet contentType res accept

HasOptionalParam TeamsGet S

Optional Param "s" - Search teams by its name.

Defined in Vikunja.API.Team

Methods

applyOptionalParam :: VikunjaRequest TeamsGet contentType res accept -> S -> VikunjaRequest TeamsGet contentType res accept

(-&-) :: VikunjaRequest TeamsGet contentType res accept -> S -> VikunjaRequest TeamsGet contentType res accept

HasOptionalParam TeamsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Team

Methods

applyOptionalParam :: VikunjaRequest TeamsGet contentType res accept -> PerPage -> VikunjaRequest TeamsGet contentType res accept

(-&-) :: VikunjaRequest TeamsGet contentType res accept -> PerPage -> VikunjaRequest TeamsGet contentType res accept

HasOptionalParam TeamsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Team

Methods

applyOptionalParam :: VikunjaRequest TeamsGet contentType res accept -> Page -> VikunjaRequest TeamsGet contentType res accept

(-&-) :: VikunjaRequest TeamsGet contentType res accept -> Page -> VikunjaRequest TeamsGet contentType res accept

HasOptionalParam TasksIdAttachmentsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> PerPage -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

(-&-) :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> PerPage -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

HasOptionalParam TasksIdAttachmentsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> Page -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

(-&-) :: VikunjaRequest TasksIdAttachmentsGet contentType res accept -> Page -> VikunjaRequest TasksIdAttachmentsGet contentType res accept

HasOptionalParam TasksIdAttachmentsAttachmentIDGet PreviewSize

Optional Param "preview_size" - The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px. If provided, a preview image will be returned if the attachment is an image.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept -> PreviewSize -> VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept

(-&-) :: VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept -> PreviewSize -> VikunjaRequest TasksIdAttachmentsAttachmentIDGet contentType res accept

HasOptionalParam TasksAllGet SortBy

Optional Param "sort_by" - The sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with order_by. Possible values to sort by are id, title, description, done, done_at, due_date, created_by_id, project_id, repeat_after, priority, start_date, end_date, hex_color, percent_done, uid, created, updated. Default is id.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> SortBy -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> SortBy -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet S

Optional Param "s" - Search tasks by task text.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> S -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> S -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> PerPage -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> PerPage -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> Page -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> Page -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet OrderBy

Optional Param "order_by" - The ordering parameter. Possible values to order by are asc or desc. Default is asc.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> OrderBy -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> OrderBy -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet FilterTimezone

Optional Param "filter_timezone" - The time zone which should be used for date match (statements like

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> FilterTimezone -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> FilterTimezone -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet FilterIncludeNulls

Optional Param "filter_include_nulls" - If set to true the result will include filtered fields whose value is set to null. Available values are true or false. Defaults to false.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet Filter

Optional Param "filter" - The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation of the feature.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> Filter -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> Filter -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam TasksAllGet Expand

Optional Param "expand" - If set to subtasks, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. You can only set this to subtasks.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest TasksAllGet contentType res accept -> Expand -> VikunjaRequest TasksAllGet contentType res accept

(-&-) :: VikunjaRequest TasksAllGet contentType res accept -> Expand -> VikunjaRequest TasksAllGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet SortBy

Optional Param "sort_by" - The sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with order_by. Possible values to sort by are id, title, description, done, done_at, due_date, created_by_id, project_id, repeat_after, priority, start_date, end_date, hex_color, percent_done, uid, created, updated. Default is id.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> SortBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> SortBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet S

Optional Param "s" - Search tasks by task text.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> S -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> S -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Page -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet OrderBy

Optional Param "order_by" - The ordering parameter. Possible values to order by are asc or desc. Default is asc.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> OrderBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> OrderBy -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet FilterTimezone

Optional Param "filter_timezone" - The time zone which should be used for date match (statements like

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterTimezone -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterTimezone -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet FilterIncludeNulls

Optional Param "filter_include_nulls" - If set to true the result will include filtered fields whose value is set to null. Available values are true or false. Defaults to false.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> FilterIncludeNulls -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet Filter

Optional Param "filter" - The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation of the feature.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Filter -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Filter -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam ProjectsIdViewsViewTasksGet Expand

Optional Param "expand" - If set to subtasks, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. You can only set this to subtasks.

Defined in Vikunja.API.Task

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Expand -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept -> Expand -> VikunjaRequest ProjectsIdViewsViewTasksGet contentType res accept

HasOptionalParam NotificationsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Subscriptions

Methods

applyOptionalParam :: VikunjaRequest NotificationsGet contentType res accept -> PerPage -> VikunjaRequest NotificationsGet contentType res accept

(-&-) :: VikunjaRequest NotificationsGet contentType res accept -> PerPage -> VikunjaRequest NotificationsGet contentType res accept

HasOptionalParam NotificationsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Subscriptions

Methods

applyOptionalParam :: VikunjaRequest NotificationsGet contentType res accept -> Page -> VikunjaRequest NotificationsGet contentType res accept

(-&-) :: VikunjaRequest NotificationsGet contentType res accept -> Page -> VikunjaRequest NotificationsGet contentType res accept

HasOptionalParam ProjectsProjectSharesGet S

Optional Param "s" - Search shares by hash.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsProjectSharesGet contentType res accept -> S -> VikunjaRequest ProjectsProjectSharesGet contentType res accept

(-&-) :: VikunjaRequest ProjectsProjectSharesGet contentType res accept -> S -> VikunjaRequest ProjectsProjectSharesGet contentType res accept

HasOptionalParam ProjectsProjectSharesGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsProjectSharesGet contentType res accept -> PerPage -> VikunjaRequest ProjectsProjectSharesGet contentType res accept

(-&-) :: VikunjaRequest ProjectsProjectSharesGet contentType res accept -> PerPage -> VikunjaRequest ProjectsProjectSharesGet contentType res accept

HasOptionalParam ProjectsProjectSharesGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsProjectSharesGet contentType res accept -> Page -> VikunjaRequest ProjectsProjectSharesGet contentType res accept

(-&-) :: VikunjaRequest ProjectsProjectSharesGet contentType res accept -> Page -> VikunjaRequest ProjectsProjectSharesGet contentType res accept

HasOptionalParam ProjectsIdUsersGet S

Optional Param "s" - Search users by its name.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdUsersGet contentType res accept -> S -> VikunjaRequest ProjectsIdUsersGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdUsersGet contentType res accept -> S -> VikunjaRequest ProjectsIdUsersGet contentType res accept

HasOptionalParam ProjectsIdUsersGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdUsersGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdUsersGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdUsersGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdUsersGet contentType res accept

HasOptionalParam ProjectsIdUsersGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdUsersGet contentType res accept -> Page -> VikunjaRequest ProjectsIdUsersGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdUsersGet contentType res accept -> Page -> VikunjaRequest ProjectsIdUsersGet contentType res accept

HasOptionalParam ProjectsIdTeamsGet S

Optional Param "s" - Search teams by its name.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdTeamsGet contentType res accept -> S -> VikunjaRequest ProjectsIdTeamsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdTeamsGet contentType res accept -> S -> VikunjaRequest ProjectsIdTeamsGet contentType res accept

HasOptionalParam ProjectsIdTeamsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdTeamsGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdTeamsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdTeamsGet contentType res accept -> PerPage -> VikunjaRequest ProjectsIdTeamsGet contentType res accept

HasOptionalParam ProjectsIdTeamsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Sharing

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdTeamsGet contentType res accept -> Page -> VikunjaRequest ProjectsIdTeamsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdTeamsGet contentType res accept -> Page -> VikunjaRequest ProjectsIdTeamsGet contentType res accept

HasOptionalParam ProjectsIdProjectusersGet S

Optional Param "s" - Search for a user by its name.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest ProjectsIdProjectusersGet contentType res accept -> S -> VikunjaRequest ProjectsIdProjectusersGet contentType res accept

(-&-) :: VikunjaRequest ProjectsIdProjectusersGet contentType res accept -> S -> VikunjaRequest ProjectsIdProjectusersGet contentType res accept

HasOptionalParam ProjectsGet S

Optional Param "s" - Search projects by title.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest ProjectsGet contentType res accept -> S -> VikunjaRequest ProjectsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsGet contentType res accept -> S -> VikunjaRequest ProjectsGet contentType res accept

HasOptionalParam ProjectsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest ProjectsGet contentType res accept -> PerPage -> VikunjaRequest ProjectsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsGet contentType res accept -> PerPage -> VikunjaRequest ProjectsGet contentType res accept

HasOptionalParam ProjectsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest ProjectsGet contentType res accept -> Page -> VikunjaRequest ProjectsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsGet contentType res accept -> Page -> VikunjaRequest ProjectsGet contentType res accept

HasOptionalParam ProjectsGet IsArchived

Optional Param "is_archived" - If true, also returns all archived projects.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest ProjectsGet contentType res accept -> IsArchived -> VikunjaRequest ProjectsGet contentType res accept

(-&-) :: VikunjaRequest ProjectsGet contentType res accept -> IsArchived -> VikunjaRequest ProjectsGet contentType res accept

HasOptionalParam BackgroundsUnsplashSearchGet S

Optional Param "s" - Search backgrounds from unsplash with this search term.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept -> S -> VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept

(-&-) :: VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept -> S -> VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept

HasOptionalParam BackgroundsUnsplashSearchGet P

Optional Param "p" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Project

Methods

applyOptionalParam :: VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept -> P -> VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept

(-&-) :: VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept -> P -> VikunjaRequest BackgroundsUnsplashSearchGet contentType res accept

HasOptionalParam TasksTaskLabelsGet S

Optional Param "s" - Search labels by label text.

Defined in Vikunja.API.Labels

Methods

applyOptionalParam :: VikunjaRequest TasksTaskLabelsGet contentType res accept -> S -> VikunjaRequest TasksTaskLabelsGet contentType res accept

(-&-) :: VikunjaRequest TasksTaskLabelsGet contentType res accept -> S -> VikunjaRequest TasksTaskLabelsGet contentType res accept

HasOptionalParam TasksTaskLabelsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Labels

Methods

applyOptionalParam :: VikunjaRequest TasksTaskLabelsGet contentType res accept -> PerPage -> VikunjaRequest TasksTaskLabelsGet contentType res accept

(-&-) :: VikunjaRequest TasksTaskLabelsGet contentType res accept -> PerPage -> VikunjaRequest TasksTaskLabelsGet contentType res accept

HasOptionalParam TasksTaskLabelsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Labels

Methods

applyOptionalParam :: VikunjaRequest TasksTaskLabelsGet contentType res accept -> Page -> VikunjaRequest TasksTaskLabelsGet contentType res accept

(-&-) :: VikunjaRequest TasksTaskLabelsGet contentType res accept -> Page -> VikunjaRequest TasksTaskLabelsGet contentType res accept

HasOptionalParam LabelsGet S

Optional Param "s" - Search labels by label text.

Defined in Vikunja.API.Labels

Methods

applyOptionalParam :: VikunjaRequest LabelsGet contentType res accept -> S -> VikunjaRequest LabelsGet contentType res accept

(-&-) :: VikunjaRequest LabelsGet contentType res accept -> S -> VikunjaRequest LabelsGet contentType res accept

HasOptionalParam LabelsGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Labels

Methods

applyOptionalParam :: VikunjaRequest LabelsGet contentType res accept -> PerPage -> VikunjaRequest LabelsGet contentType res accept

(-&-) :: VikunjaRequest LabelsGet contentType res accept -> PerPage -> VikunjaRequest LabelsGet contentType res accept

HasOptionalParam LabelsGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Labels

Methods

applyOptionalParam :: VikunjaRequest LabelsGet contentType res accept -> Page -> VikunjaRequest LabelsGet contentType res accept

(-&-) :: VikunjaRequest LabelsGet contentType res accept -> Page -> VikunjaRequest LabelsGet contentType res accept

HasOptionalParam TasksTaskIDAssigneesGet S

Optional Param "s" - Search assignees by their username.

Defined in Vikunja.API.Assignees

Methods

applyOptionalParam :: VikunjaRequest TasksTaskIDAssigneesGet contentType res accept -> S -> VikunjaRequest TasksTaskIDAssigneesGet contentType res accept

(-&-) :: VikunjaRequest TasksTaskIDAssigneesGet contentType res accept -> S -> VikunjaRequest TasksTaskIDAssigneesGet contentType res accept

HasOptionalParam TasksTaskIDAssigneesGet PerPage

Optional Param "per_page" - The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Assignees

Methods

applyOptionalParam :: VikunjaRequest TasksTaskIDAssigneesGet contentType res accept -> PerPage -> VikunjaRequest TasksTaskIDAssigneesGet contentType res accept

(-&-) :: VikunjaRequest TasksTaskIDAssigneesGet contentType res accept -> PerPage -> VikunjaRequest TasksTaskIDAssigneesGet contentType res accept

HasOptionalParam TasksTaskIDAssigneesGet Page

Optional Param "page" - The page number. Used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Assignees

Methods

applyOptionalParam :: VikunjaRequest TasksTaskIDAssigneesGet contentType res accept -> Page -> VikunjaRequest TasksTaskIDAssigneesGet contentType res accept

(-&-) :: VikunjaRequest TasksTaskIDAssigneesGet contentType res accept -> Page -> VikunjaRequest TasksTaskIDAssigneesGet contentType res accept

HasOptionalParam TokensGet S

Optional Param "s" - Search tokens by their title.

Defined in Vikunja.API.Api

Methods

applyOptionalParam :: VikunjaRequest TokensGet contentType res accept -> S -> VikunjaRequest TokensGet contentType res accept

(-&-) :: VikunjaRequest TokensGet contentType res accept -> S -> VikunjaRequest TokensGet contentType res accept

HasOptionalParam TokensGet PerPage

Optional Param "per_page" - The maximum number of tokens per page. This parameter is limited by the configured maximum of items per page.

Defined in Vikunja.API.Api

Methods

applyOptionalParam :: VikunjaRequest TokensGet contentType res accept -> PerPage -> VikunjaRequest TokensGet contentType res accept

(-&-) :: VikunjaRequest TokensGet contentType res accept -> PerPage -> VikunjaRequest TokensGet contentType res accept

HasOptionalParam TokensGet Page

Optional Param "page" - The page number, used for pagination. If not provided, the first page of results is returned.

Defined in Vikunja.API.Api

Methods

applyOptionalParam :: VikunjaRequest TokensGet contentType res accept -> Page -> VikunjaRequest TokensGet contentType res accept

(-&-) :: VikunjaRequest TokensGet contentType res accept -> Page -> VikunjaRequest TokensGet contentType res accept

data Params

Request Params

Constructors

Params

Fields

• paramsQuery :: Query
• paramsHeaders :: RequestHeaders
• paramsBody :: ParamBody

Instances

Show Params

Defined in Vikunja.Core

Methods

showsPrec :: Int -> Params -> ShowS

show :: Params -> String

showList :: [Params] -> ShowS

paramsQueryL :: Lens_' Params Query

paramsQuery Lens

paramsHeadersL :: Lens_' Params RequestHeaders

paramsHeaders Lens

paramsBodyL :: Lens_' Params ParamBody

paramsBody Lens

data ParamBody

Request Body

Constructors

ParamBodyNone

ParamBodyB ByteString

ParamBodyBL ByteString

ParamBodyFormUrlEncoded Form

ParamBodyMultipartFormData [Part]

Instances

Show ParamBody

Defined in Vikunja.Core

Methods

showsPrec :: Int -> ParamBody -> ShowS

show :: ParamBody -> String

showList :: [ParamBody] -> ShowS

VikunjaRequest Utils

_mkRequest

Arguments

:: Method

Method

-> [ByteString]

Endpoint

-> VikunjaRequest req contentType res accept

req: Request Type, res: Response Type

_mkParams :: Params

setHeader :: VikunjaRequest req contentType res accept -> [Header] -> VikunjaRequest req contentType res accept

addHeader :: VikunjaRequest req contentType res accept -> [Header] -> VikunjaRequest req contentType res accept

removeHeader :: VikunjaRequest req contentType res accept -> [HeaderName] -> VikunjaRequest req contentType res accept

_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => VikunjaRequest req contentType res accept -> VikunjaRequest req contentType res accept

_setAcceptHeader :: forall req contentType res accept. MimeType accept => VikunjaRequest req contentType res accept -> VikunjaRequest req contentType res accept

setQuery :: VikunjaRequest req contentType res accept -> [QueryItem] -> VikunjaRequest req contentType res accept

addQuery :: VikunjaRequest req contentType res accept -> [QueryItem] -> VikunjaRequest req contentType res accept

addForm :: VikunjaRequest req contentType res accept -> Form -> VikunjaRequest req contentType res accept

_addMultiFormPart :: VikunjaRequest req contentType res accept -> Part -> VikunjaRequest req contentType res accept

_setBodyBS :: VikunjaRequest req contentType res accept -> ByteString -> VikunjaRequest req contentType res accept

_setBodyLBS :: VikunjaRequest req contentType res accept -> ByteString -> VikunjaRequest req contentType res accept

_hasAuthType :: AuthMethod authMethod => VikunjaRequest req contentType res accept -> Proxy authMethod -> VikunjaRequest req contentType res accept

Params Utils

toPath :: ToHttpApiData a => a -> ByteString

toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header]

toForm :: ToHttpApiData v => (ByteString, v) -> Form

toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem]

toJsonQuery :: ToJSON a => (ByteString, Maybe a) -> [QueryItem]

toPartialEscapeQuery :: ByteString -> Query -> PartialEscapeQuery

OpenAPI CollectionFormat Utils

data CollectionFormat

Determines the format of the array if type array is used.

Constructors

CommaSeparated

CSV format for multiple parameters.

SpaceSeparated

Also called SSV

TabSeparated

Also called TSV

PipeSeparated

`value1|value2|value2`

MultiParamArray

Using multiple GET parameters, e.g. `foo=bar&foo=baz`. This is valid only for parameters in "query" (Query) or "formData" (Form)

toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header]

toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form

toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query

toJsonQueryColl :: ToJSON a => CollectionFormat -> (ByteString, Maybe [a]) -> Query

_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)]

_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)]

_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)]

AuthMethods

class Typeable a => AuthMethod a where

Provides a method to apply auth methods to requests

Methods

applyAuthMethod :: VikunjaConfig -> a -> VikunjaRequest req contentType res accept -> IO (VikunjaRequest req contentType res accept)

Instances

AuthMethod AnyAuthMethod

Defined in Vikunja.Core

Methods

applyAuthMethod :: VikunjaConfig -> AnyAuthMethod -> VikunjaRequest req contentType res accept -> IO (VikunjaRequest req contentType res accept)

AuthMethod AuthApiKeyJWTKeyAuth

Defined in Vikunja.Model

Methods

applyAuthMethod :: VikunjaConfig -> AuthApiKeyJWTKeyAuth -> VikunjaRequest req contentType res accept -> IO (VikunjaRequest req contentType res accept)

AuthMethod AuthBasicBasicAuth

Defined in Vikunja.Model

Methods

applyAuthMethod :: VikunjaConfig -> AuthBasicBasicAuth -> VikunjaRequest req contentType res accept -> IO (VikunjaRequest req contentType res accept)

data AnyAuthMethod

An existential wrapper for any AuthMethod

Constructors

forall a.AuthMethod a => AnyAuthMethod a

Instances

AuthMethod AnyAuthMethod

Defined in Vikunja.Core

Methods

applyAuthMethod :: VikunjaConfig -> AnyAuthMethod -> VikunjaRequest req contentType res accept -> IO (VikunjaRequest req contentType res accept)

data AuthMethodException

indicates exceptions related to AuthMethods

Constructors

AuthMethodException String

Instances

Show AuthMethodException

Defined in Vikunja.Core

Methods

showsPrec :: Int -> AuthMethodException -> ShowS

show :: AuthMethodException -> String

showList :: [AuthMethodException] -> ShowS

Exception AuthMethodException

Defined in Vikunja.Core

Methods

toException :: AuthMethodException -> SomeException

fromException :: SomeException -> Maybe AuthMethodException

displayException :: AuthMethodException -> String

_applyAuthMethods :: VikunjaRequest req contentType res accept -> VikunjaConfig -> IO (VikunjaRequest req contentType res accept)

apply all matching AuthMethods in config to request

Utils

_omitNulls :: [(Key, Value)] -> Value

Removes Null fields. (OpenAPI-Specification 2.0 does not allow Null in JSON)

_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text])

Encodes fields using WH.toQueryParam

_emptyToNothing :: Maybe String -> Maybe String

Collapse (Just "") to Nothing

_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a

Collapse (Just mempty) to Nothing

DateTime Formatting

newtype DateTime

Constructors

DateTime

Fields

• unDateTime :: UTCTime

Instances

Eq DateTime

Defined in Vikunja.Core

Methods

(==) :: DateTime -> DateTime -> Bool

(/=) :: DateTime -> DateTime -> Bool

Data DateTime

Defined in Vikunja.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateTime -> c DateTime

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateTime

toConstr :: DateTime -> Constr

dataTypeOf :: DateTime -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateTime)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateTime)

gmapT :: (forall b. Data b => b -> b) -> DateTime -> DateTime

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r

gmapQ :: (forall d. Data d => d -> u) -> DateTime -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DateTime -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime

Ord DateTime

Defined in Vikunja.Core

Methods

compare :: DateTime -> DateTime -> Ordering

(<) :: DateTime -> DateTime -> Bool

(<=) :: DateTime -> DateTime -> Bool

(>) :: DateTime -> DateTime -> Bool

(>=) :: DateTime -> DateTime -> Bool

max :: DateTime -> DateTime -> DateTime

min :: DateTime -> DateTime -> DateTime

Show DateTime

Defined in Vikunja.Core

Methods

showsPrec :: Int -> DateTime -> ShowS

show :: DateTime -> String

showList :: [DateTime] -> ShowS

ToJSON DateTime

Defined in Vikunja.Core

Methods

toJSON :: DateTime -> Value

toEncoding :: DateTime -> Encoding

toJSONList :: [DateTime] -> Value

toEncodingList :: [DateTime] -> Encoding

FromJSON DateTime

Defined in Vikunja.Core

Methods

parseJSON :: Value -> Parser DateTime

parseJSONList :: Value -> Parser [DateTime]

NFData DateTime

Defined in Vikunja.Core

Methods

rnf :: DateTime -> ()

ToHttpApiData DateTime

Defined in Vikunja.Core

Methods

toUrlPiece :: DateTime -> Text

toEncodedUrlPiece :: DateTime -> Builder

toHeader :: DateTime -> ByteString

toQueryParam :: DateTime -> Text

FromHttpApiData DateTime

Defined in Vikunja.Core

Methods

parseUrlPiece :: Text -> Either Text DateTime

parseHeader :: ByteString -> Either Text DateTime

parseQueryParam :: Text -> Either Text DateTime

MimeRender MimeMultipartFormData DateTime

Defined in Vikunja.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> DateTime -> ByteString

mimeRender' :: MimeMultipartFormData -> DateTime -> ByteString

_readDateTime :: (MonadFail m, Alternative m) => String -> m DateTime

_parseISO8601

_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String

TI.formatISO8601Millis

_parseISO8601 :: (ParseTime t, MonadFail m, Alternative m) => String -> m t

parse an ISO8601 date-time string

Date Formatting

newtype Date

Constructors

Date

Fields

• unDate :: Day

Instances

Enum Date

Defined in Vikunja.Core

Methods

succ :: Date -> Date

pred :: Date -> Date

toEnum :: Int -> Date

fromEnum :: Date -> Int

enumFrom :: Date -> [Date]

enumFromThen :: Date -> Date -> [Date]

enumFromTo :: Date -> Date -> [Date]

enumFromThenTo :: Date -> Date -> Date -> [Date]

Eq Date

Defined in Vikunja.Core

Methods

(==) :: Date -> Date -> Bool

(/=) :: Date -> Date -> Bool

Data Date

Defined in Vikunja.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date

toConstr :: Date -> Constr

dataTypeOf :: Date -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date)

gmapT :: (forall b. Data b => b -> b) -> Date -> Date

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r

gmapQ :: (forall d. Data d => d -> u) -> Date -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date

Ord Date

Defined in Vikunja.Core

Methods

compare :: Date -> Date -> Ordering

(<) :: Date -> Date -> Bool

(<=) :: Date -> Date -> Bool

(>) :: Date -> Date -> Bool

(>=) :: Date -> Date -> Bool

max :: Date -> Date -> Date

min :: Date -> Date -> Date

Show Date

Defined in Vikunja.Core

Methods

showsPrec :: Int -> Date -> ShowS

show :: Date -> String

showList :: [Date] -> ShowS

Ix Date

Defined in Vikunja.Core

Methods

range :: (Date, Date) -> [Date]

index :: (Date, Date) -> Date -> Int

unsafeIndex :: (Date, Date) -> Date -> Int

inRange :: (Date, Date) -> Date -> Bool

rangeSize :: (Date, Date) -> Int

unsafeRangeSize :: (Date, Date) -> Int

ToJSON Date

Defined in Vikunja.Core

Methods

toJSON :: Date -> Value

toEncoding :: Date -> Encoding

toJSONList :: [Date] -> Value

toEncodingList :: [Date] -> Encoding

FromJSON Date

Defined in Vikunja.Core

Methods

parseJSON :: Value -> Parser Date

parseJSONList :: Value -> Parser [Date]

NFData Date

Defined in Vikunja.Core

Methods

rnf :: Date -> ()

ToHttpApiData Date

Defined in Vikunja.Core

Methods

toUrlPiece :: Date -> Text

toEncodedUrlPiece :: Date -> Builder

toHeader :: Date -> ByteString

toQueryParam :: Date -> Text

FromHttpApiData Date

Defined in Vikunja.Core

Methods

parseUrlPiece :: Text -> Either Text Date

parseHeader :: ByteString -> Either Text Date

parseQueryParam :: Text -> Either Text Date

MimeRender MimeMultipartFormData Date

Defined in Vikunja.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> Date -> ByteString

mimeRender' :: MimeMultipartFormData -> Date -> ByteString

_readDate :: MonadFail m => String -> m Date

TI.parseTimeM True TI.defaultTimeLocale "%Y-%m-%d"

_showDate :: FormatTime t => t -> String

TI.formatTime TI.defaultTimeLocale "%Y-%m-%d"

Byte/Binary Formatting

newtype ByteArray

base64 encoded characters

Constructors

ByteArray

Fields

• unByteArray :: ByteString

Instances

Eq ByteArray

Defined in Vikunja.Core

Methods

(==) :: ByteArray -> ByteArray -> Bool

(/=) :: ByteArray -> ByteArray -> Bool

Data ByteArray

Defined in Vikunja.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteArray -> c ByteArray

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteArray

toConstr :: ByteArray -> Constr

dataTypeOf :: ByteArray -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteArray)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteArray)

gmapT :: (forall b. Data b => b -> b) -> ByteArray -> ByteArray

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r

gmapQ :: (forall d. Data d => d -> u) -> ByteArray -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteArray -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray

Ord ByteArray

Defined in Vikunja.Core

Methods

compare :: ByteArray -> ByteArray -> Ordering

(<) :: ByteArray -> ByteArray -> Bool

(<=) :: ByteArray -> ByteArray -> Bool

(>) :: ByteArray -> ByteArray -> Bool

(>=) :: ByteArray -> ByteArray -> Bool

max :: ByteArray -> ByteArray -> ByteArray

min :: ByteArray -> ByteArray -> ByteArray

Show ByteArray

Defined in Vikunja.Core

Methods

showsPrec :: Int -> ByteArray -> ShowS

show :: ByteArray -> String

showList :: [ByteArray] -> ShowS

ToJSON ByteArray

Defined in Vikunja.Core

Methods

toJSON :: ByteArray -> Value

toEncoding :: ByteArray -> Encoding

toJSONList :: [ByteArray] -> Value

toEncodingList :: [ByteArray] -> Encoding

FromJSON ByteArray

Defined in Vikunja.Core

Methods

parseJSON :: Value -> Parser ByteArray

parseJSONList :: Value -> Parser [ByteArray]

NFData ByteArray

Defined in Vikunja.Core

Methods

rnf :: ByteArray -> ()

ToHttpApiData ByteArray

Defined in Vikunja.Core

Methods

toUrlPiece :: ByteArray -> Text

toEncodedUrlPiece :: ByteArray -> Builder

toHeader :: ByteArray -> ByteString

toQueryParam :: ByteArray -> Text

FromHttpApiData ByteArray

Defined in Vikunja.Core

Methods

parseUrlPiece :: Text -> Either Text ByteArray

parseHeader :: ByteString -> Either Text ByteArray

parseQueryParam :: Text -> Either Text ByteArray

MimeRender MimeMultipartFormData ByteArray

Defined in Vikunja.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> ByteArray -> ByteString

mimeRender' :: MimeMultipartFormData -> ByteArray -> ByteString

_readByteArray :: MonadFail m => Text -> m ByteArray

read base64 encoded characters

_showByteArray :: ByteArray -> Text

show base64 encoded characters

newtype Binary

any sequence of octets

Constructors

Binary

Fields

• unBinary :: ByteString

Instances

Eq Binary

Defined in Vikunja.Core

Methods

(==) :: Binary -> Binary -> Bool

(/=) :: Binary -> Binary -> Bool

Data Binary

Defined in Vikunja.Core

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binary -> c Binary

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binary

toConstr :: Binary -> Constr

dataTypeOf :: Binary -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binary)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binary)

gmapT :: (forall b. Data b => b -> b) -> Binary -> Binary

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r

gmapQ :: (forall d. Data d => d -> u) -> Binary -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Binary -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binary -> m Binary

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary

Ord Binary

Defined in Vikunja.Core

Methods

compare :: Binary -> Binary -> Ordering

(<) :: Binary -> Binary -> Bool

(<=) :: Binary -> Binary -> Bool

(>) :: Binary -> Binary -> Bool

(>=) :: Binary -> Binary -> Bool

max :: Binary -> Binary -> Binary

min :: Binary -> Binary -> Binary

Show Binary

Defined in Vikunja.Core

Methods

showsPrec :: Int -> Binary -> ShowS

show :: Binary -> String

showList :: [Binary] -> ShowS

ToJSON Binary

Defined in Vikunja.Core

Methods

toJSON :: Binary -> Value

toEncoding :: Binary -> Encoding

toJSONList :: [Binary] -> Value

toEncodingList :: [Binary] -> Encoding

FromJSON Binary

Defined in Vikunja.Core

Methods

parseJSON :: Value -> Parser Binary

parseJSONList :: Value -> Parser [Binary]

NFData Binary

Defined in Vikunja.Core

Methods

rnf :: Binary -> ()

ToHttpApiData Binary

Defined in Vikunja.Core

Methods

toUrlPiece :: Binary -> Text

toEncodedUrlPiece :: Binary -> Builder

toHeader :: Binary -> ByteString

toQueryParam :: Binary -> Text

FromHttpApiData Binary

Defined in Vikunja.Core

Methods

parseUrlPiece :: Text -> Either Text Binary

parseHeader :: ByteString -> Either Text Binary

parseQueryParam :: Text -> Either Text Binary

MimeRender MimeMultipartFormData Binary

Defined in Vikunja.Core

Methods

mimeRender :: Proxy MimeMultipartFormData -> Binary -> ByteString

mimeRender' :: MimeMultipartFormData -> Binary -> ByteString

_readBinaryBase64 :: MonadFail m => Text -> m Binary

_showBinaryBase64 :: Binary -> Text

Lens Type Aliases

type Lens_' s a = Lens_ s s a a

type Lens_ s t a b = forall (f :: Type -> Type). Functor f => (a -> f b) -> s -> f t