tricycle/morty-api/1.0.0

NOTE: this package is not compatible with Elm 0.19.1

MortyAPI.Commands

Provides commands and command parameters for making API calls.

type alias ApproachParameters a =
{ mortyApiToken : String
, mortyHost : String
, msgType : WebData Approach -> a
}

Parameters required to POST a new Task Approach

type alias CurrentUserParameters a =
{ mortyApiToken : String
, mortyHost : String
, msgType : WebData User -> a
}

Parameters required to retrieve the current user

{ mortyApiToken : String
, mortyHost : String
, teamId : Int
, msgType : WebData KanbanLanesSuccessResponse -> a
}

Parameters required to retrieve the kanban board for a full team

{ mortyApiToken : String
, mortyHost : String
, userId : Int
, msgType : WebData KanbanLanesSuccessResponse -> a
}

Parameters required to retrieve the kanban board for a single user

type alias TasksParameters a =
{ mortyApiToken : String
, mortyHost : String
, ownerType : Maybe String
, ownerId : Maybe Int
, taskScope : Maybe String
, taskScopeParam : Maybe String
, msgType : WebData (List Task) -> a
}

Parameters required to retrieve task matching owner and scope

type alias TaskParameters a =
{ mortyApiToken : String
, mortyHost : String
, taskId : Int
, msgType : WebData Task -> a
}

Parameters required to retrieve a task

getCurrentUserCommand : CurrentUserParameters a -> Cmd a

Gets the current user from the API

getKanbanLanesForTeam : KanbanLanesForTeamParameters a -> Cmd a

Retrieves all kanban lanes for a team

getKanbanLanesForUser : KanbanLanesForUserParameters a -> Cmd a

Retrieves all kanban lanes for a user

getTaskCommand : TaskParameters a -> Cmd a

Gets a task from the API

getTasksCommand : TasksParameters a -> Cmd a

Gets a list of tasks matching the filter criteria from the API

postTaskApproachCommand : ApproachParameters a -> Approach -> Cmd a

POSTs a new task approach to the API

putTaskUpdateCommand : TaskParameters a -> Task -> Cmd a

Updates the properties of a task using a PUT call to the API