Vikunja.API.Sharing

Operations

Sharing

notificationsPost

notificationsPost :: VikunjaRequest NotificationsPost MimeNoContent ModelsMessage MimeJSON

POST /notifications

Mark all notifications of a user as read

data NotificationsPost

Instances

Produces NotificationsPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

projectsIdTeamsGet

projectsIdTeamsGet

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdTeamsGet MimeNoContent [ModelsTeamWithRight] MimeJSON

GET /projects/{id}/teams

Get teams on a project

Returns a project with all teams which have access on a given project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdTeamsGet

Instances

Produces ProjectsIdTeamsGet MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsIdTeamsPut

projectsIdTeamsPut

Arguments

:: (Consumes ProjectsIdTeamsPut MimeJSON, MimeRender MimeJSON ModelsTeamProject)

=> ModelsTeamProject

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

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdTeamsPut MimeJSON ModelsTeamProject MimeJSON

PUT /projects/{id}/teams

Add a team to a project

Gives a team access to a project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdTeamsPut

Instances

Produces ProjectsIdTeamsPut MimeJSON

application/json

Defined in Vikunja.API.Sharing

Consumes ProjectsIdTeamsPut MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsIdUsersGet

projectsIdUsersGet

Arguments

:: Id

"id" - Project ID

-> VikunjaRequest ProjectsIdUsersGet MimeNoContent [ModelsUserWithRight] MimeJSON

GET /projects/{id}/users

Get users on a project

Returns a project with all users which have access on a given project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdUsersGet

Instances

Produces ProjectsIdUsersGet MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsIdUsersPut

projectsIdUsersPut

Arguments

:: (Consumes ProjectsIdUsersPut MimeJSON, MimeRender MimeJSON ModelsProjectUser)

=> ModelsProjectUser

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

-> Id

"id" - Project ID

-> VikunjaRequest ProjectsIdUsersPut MimeJSON ModelsProjectUser MimeJSON

PUT /projects/{id}/users

Add a user to a project

Gives a user access to a project.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsIdUsersPut

Instances

Produces ProjectsIdUsersPut MimeJSON

application/json

Defined in Vikunja.API.Sharing

Consumes ProjectsIdUsersPut MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsProjectIDTeamsTeamIDDelete

projectsProjectIDTeamsTeamIDDelete

Arguments

:: ProjectId

"projectId" - Project ID

-> TeamId

"teamId" - Team ID

-> VikunjaRequest ProjectsProjectIDTeamsTeamIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{projectID}/teams/{teamID}

Delete a team from a project

Delets a team from a project. The team won't have access to the project anymore.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDTeamsTeamIDDelete

Instances

Produces ProjectsProjectIDTeamsTeamIDDelete MimeJSON

application/json

Defined in Vikunja.API.Sharing

projectsProjectIDTeamsTeamIDPost

projectsProjectIDTeamsTeamIDPost

Arguments

:: (Consumes ProjectsProjectIDTeamsTeamIDPost MimeJSON, MimeRender MimeJSON ModelsTeamProject)

=> ModelsTeamProject

"project" - The team you want to update.

-> ProjectId

"projectId" - Project ID

-> TeamId

"teamId" - Team ID

-> VikunjaRequest ProjectsProjectIDTeamsTeamIDPost MimeJSON ModelsTeamProject MimeJSON

POST /projects/{projectID}/teams/{teamID}

Update a team - project relation

Update a team - project relation. Mostly used to update the right that team has.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDTeamsTeamIDPost

Instances

Produces ProjectsProjectIDTeamsTeamIDPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

Consumes ProjectsProjectIDTeamsTeamIDPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsProjectIDUsersUserIDDelete

projectsProjectIDUsersUserIDDelete

Arguments

:: ProjectId

"projectId" - Project ID

-> UserId

"userId" - User ID

-> VikunjaRequest ProjectsProjectIDUsersUserIDDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{projectID}/users/{userID}

Delete a user from a project

Delets a user from a project. The user won't have access to the project anymore.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDUsersUserIDDelete

Instances

Produces ProjectsProjectIDUsersUserIDDelete MimeJSON

application/json

Defined in Vikunja.API.Sharing

projectsProjectIDUsersUserIDPost

projectsProjectIDUsersUserIDPost

Arguments

:: (Consumes ProjectsProjectIDUsersUserIDPost MimeJSON, MimeRender MimeJSON ModelsProjectUser)

=> ModelsProjectUser

"project" - The user you want to update.

-> ProjectId

"projectId" - Project ID

-> UserId

"userId" - User ID

-> VikunjaRequest ProjectsProjectIDUsersUserIDPost MimeJSON ModelsProjectUser MimeJSON

POST /projects/{projectID}/users/{userID}

Update a user - project relation

Update a user - project relation. Mostly used to update the right that user has.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectIDUsersUserIDPost

Instances

Produces ProjectsProjectIDUsersUserIDPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

Consumes ProjectsProjectIDUsersUserIDPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsProjectSharesGet

projectsProjectSharesGet

Arguments

:: Project

"project" - Project ID

-> VikunjaRequest ProjectsProjectSharesGet MimeNoContent [ModelsLinkSharing] MimeJSON

GET /projects/{project}/shares

Get all link shares for a project

Returns all link shares which exist for a given project

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectSharesGet

Instances

Produces ProjectsProjectSharesGet MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsProjectSharesPut

projectsProjectSharesPut

Arguments

:: (Consumes ProjectsProjectSharesPut MimeJSON, MimeRender MimeJSON ModelsLinkSharing)

=> ModelsLinkSharing

"label" - The new link share object

-> Project

"project" - Project ID

-> VikunjaRequest ProjectsProjectSharesPut MimeJSON ModelsLinkSharing MimeJSON

PUT /projects/{project}/shares

Share a project via link

Share a project via link. The user needs to have write-access to the project to be able do this.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectSharesPut

Instances

Produces ProjectsProjectSharesPut MimeJSON

application/json

Defined in Vikunja.API.Sharing

Consumes ProjectsProjectSharesPut MimeJSON

application/json

Defined in Vikunja.API.Sharing

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

projectsProjectSharesShareDelete

projectsProjectSharesShareDelete

Arguments

:: Project

"project" - Project ID

-> Share

"share" - Share Link ID

-> VikunjaRequest ProjectsProjectSharesShareDelete MimeNoContent ModelsMessage MimeJSON

DELETE /projects/{project}/shares/{share}

Remove a link share

Remove a link share. The user needs to have write-access to the project to be able do this.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectSharesShareDelete

Instances

Produces ProjectsProjectSharesShareDelete MimeJSON

application/json

Defined in Vikunja.API.Sharing

projectsProjectSharesShareGet

projectsProjectSharesShareGet

Arguments

:: Project

"project" - Project ID

-> Share

"share" - Share ID

-> VikunjaRequest ProjectsProjectSharesShareGet MimeNoContent ModelsLinkSharing MimeJSON

GET /projects/{project}/shares/{share}

Get one link shares for a project

Returns one link share by its ID.

AuthMethod: AuthApiKeyJWTKeyAuth

data ProjectsProjectSharesShareGet

Instances

Produces ProjectsProjectSharesShareGet MimeJSON

application/json

Defined in Vikunja.API.Sharing

sharesShareAuthPost

sharesShareAuthPost

Arguments

:: (Consumes SharesShareAuthPost MimeJSON, MimeRender MimeJSON V1LinkShareAuth)

=> V1LinkShareAuth

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

-> ShareText

"share" - The share hash

-> VikunjaRequest SharesShareAuthPost MimeJSON AuthToken MimeJSON

POST /shares/{share}/auth

Get an auth token for a share

Get a jwt auth token for a shared project from a share hash.

data SharesShareAuthPost

Instances

Produces SharesShareAuthPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

Consumes SharesShareAuthPost MimeJSON

application/json

Defined in Vikunja.API.Sharing

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