github4s/github4s.algebras/Issues

Issues

trait Issues[F[_]]
class Object
trait Matchable
class Any

Value members

Abstract methods

def addLabels(owner: String, repo: String, number: Int, labels: List[String], headers: Map[String, String]): F[GHResponse[List[Label]]]

Add the specified labels to an Issue

Add the specified labels to an Issue

Value parameters:
headers

optional user headers to include in the request

labels

the list of labels to add to the issue

number

Issue number

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the list of labels added to the Issue.

def createComment(owner: String, repo: String, number: Int, body: String, headers: Map[String, String]): F[GHResponse[Comment]]

Create a comment

Create a comment

Value parameters:
body

Comment body

headers

optional user headers to include in the request

number

Issue number

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the created Comment

def createIssue(owner: String, repo: String, title: String, body: String, milestone: Option[Int], labels: List[String], assignees: List[String], headers: Map[String, String]): F[GHResponse[Issue]]

Create an issue

Create an issue

Value parameters:
assignees

Logins for Users to assign to this issue.

body

The contents of the issue.

headers

optional user headers to include in the request

labels

Labels to associate with this issue.

milestone

The number of the milestone to associate this issue with.

owner

of the repo

repo

name of the repo

title

The title of the issue.

def createLabel(owner: String, repo: String, label: Label, headers: Map[String, String]): F[GHResponse[Label]]

Create label in repository

Create label in repository

Value parameters:
headers

optional user headers to include in the request

label

label to create in the repository

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the created Label.

def createMilestone(owner: String, repo: String, title: String, state: Option[String], description: Option[String], due_on: Option[ZonedDateTime], headers: Map[String, String]): F[GHResponse[Milestone]]

Create a milestone

Create a milestone

Value parameters:
description

A description of the milestone.

due_on

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

headers

optional user headers to include in the request

owner

repo owner

repo

repo name

state

The state of the milestone. Either open or closed. Default: open

title

The title of the milestone.

Returns:

a GHResponse with the created Milestone

def deleteComment(owner: String, repo: String, id: Long, headers: Map[String, String]): F[GHResponse[Unit]]

Delete a comment

Delete a comment

Value parameters:
headers

optional user headers to include in the request

id

Comment id

owner

of the repo

repo

name of the repo

Returns:

a unit GHResponse

def deleteLabel(owner: String, repo: String, label: String, headers: Map[String, String]): F[GHResponse[Unit]]

Delete label for repository

Delete label for repository

Value parameters:
headers

optional user headers to include in the request

label

the name of the label to delete from the repository

owner

of the repo

repo

name of the repo

Returns:

a Unit GHResponse

def deleteMilestone(owner: String, repo: String, milestone_number: Int, headers: Map[String, String]): F[GHResponse[Unit]]

Delete a milestone

Delete a milestone

Value parameters:
headers

optional user headers to include in the request

milestone_number

number of milestone

owner

repo owner

repo

repo name

Returns:

a Unit GHResponse

def editComment(owner: String, repo: String, id: Long, body: String, headers: Map[String, String]): F[GHResponse[Comment]]

Edit a comment

Edit a comment

Value parameters:
body

Comment body

headers

optional user headers to include in the request

id

Comment id

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the edited Comment

def editIssue(owner: String, repo: String, issue: Int, state: String, title: String, body: String, milestone: Option[Int], labels: List[String], assignees: List[String], headers: Map[String, String]): F[GHResponse[Issue]]

Edit an issue

Edit an issue

Value parameters:
assignees

Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty list to clear all assignees from the Issue.

body

The contents of the issue.

headers

optional user headers to include in the request

issue

number

labels

Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty list to clear all Labels from the Issue.

milestone

The number of the milestone to associate this issue with.

owner

of the repo

repo

name of the repo

state

State of the issue. Either open or closed.

title

The title of the issue.

def getIssue(owner: String, repo: String, number: Int, headers: Map[String, String]): F[GHResponse[Issue]]

Get a single issue of a repository

Get a single issue of a repository

Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.

This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a pull_request key.

Value parameters:
headers

optional user headers to include in the request

number

Issue number

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the issue list.

def getMilestone(owner: String, repo: String, number: Int, headers: Map[String, String]): F[GHResponse[Milestone]]

Get a single milestone

Get a single milestone

Value parameters:
headers

optional user headers to include in the request

number

Milestone number

owner

repo owner

repo

repo name

Returns:

a GHResponse with a Milestone

def listAvailableAssignees(owner: String, repo: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[User]]]

List available assignees for issues

List available assignees for issues

Value parameters:
headers

optional user headers to include in the request

owner

repo owner

pagination

Limit and Offset for pagination

repo

repo name

Returns:

a GHResponse with the list of available assignees for issues in specified repository

def listComments(owner: String, repo: String, number: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Comment]]]

List comments to an Issue

List comments to an Issue

Value parameters:
headers

optional user headers to include in the request

number

Issue number

owner

of the repo

pagination

Limit and Offset for pagination

repo

name of the repo

Returns:

a GHResponse with the comment list of the Issue.

def listIssues(owner: String, repo: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Issue]]]

List issues for a repository

List issues for a repository

Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.

This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a pull_request key.

Value parameters:
headers

optional user headers to include in the request

owner

of the repo

pagination

Limit and Offset for pagination

repo

name of the repo

Returns:

a GHResponse with the issue list.

def listLabels(owner: String, repo: String, number: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Label]]]

List the labels assigned to an Issue

List the labels assigned to an Issue

Value parameters:
headers

optional user headers to include in the request

number

Issue number

owner

of the repo

pagination

Limit and Offset for pagination, optional.

repo

name of the repo

Returns:

a GHResponse with the list of labels for the Issue.

def listLabelsRepository(owner: String, repo: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Label]]]

List the labels assigned to a Repository

List the labels assigned to a Repository

Value parameters:
headers

optional user headers to include in the request

owner

of the repo

pagination

Limit and Offset for pagination, optional.

repo

name of the repo

Returns:

a GHResponse with the list of labels for the Repository.

def listMilestones(owner: String, repo: String, state: Option[String], sort: Option[String], direction: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Milestone]]]

List milestone in specified repository

List milestone in specified repository

Value parameters:
direction

The direction of the sort. Either asc or desc. Default: asc

headers

optional user headers to include in the request

owner

repo owner

pagination

Limit and Offset for pagination

repo

repo name

sort

What to sort results by. Either due_on or completeness. Default: due_on

state

filter milestones returned by their state. Can be either open, closed, all. Default: open

Returns:

a GHResponse with the list of milestones in specified repository

def removeLabel(owner: String, repo: String, number: Int, label: String, headers: Map[String, String]): F[GHResponse[List[Label]]]

Remove the specified label from an Issue

Remove the specified label from an Issue

Value parameters:
headers

optional user headers to include in the request

label

the name of the label to remove from the issue

number

Issue number

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the list of labels removed from the Issue.

def searchIssues(query: String, searchParams: List[SearchParam], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[SearchIssuesResult]]

Search for issues

Search for issues

Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.

This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a pull_request key.

Value parameters:
headers

optional user headers to include in the request

pagination

Limit and Offset for pagination

query

the query string for the search

searchParams

list of search params

Returns:

a GHResponse with the result of the search.

def updateLabel(owner: String, repo: String, label: Label, headers: Map[String, String]): F[GHResponse[Label]]

Update label in repository

Update label in repository

Value parameters:
headers

optional user headers to include in the request

label

label to update in the repository

owner

of the repo

repo

name of the repo

Returns:

a GHResponse with the updated Label.

def updateMilestone(owner: String, repo: String, milestone_number: Int, title: String, state: Option[String], description: Option[String], due_on: Option[ZonedDateTime], headers: Map[String, String]): F[GHResponse[Milestone]]

Update a milestone

Update a milestone

Value parameters:
description

A description of the milestone.

due_on

The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

headers

optional user headers to include in the request

milestone_number

number of milestone

owner

repo owner

repo

repo name

state

The state of the milestone. Either open or closed. Default: open

title

The title of the milestone.

Returns:

a GHResponse with the updated Milestone