github4s/github4s.algebras/PullRequests

PullRequests

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

Value members

Abstract methods

def addReviewers(owner: String, repo: String, pullRequest: Int, reviewers: ReviewersRequest, headers: Map[String, String]): F[GHResponse[PullRequest]]
def createPullRequest(owner: String, repo: String, newPullRequest: NewPullRequest, head: String, base: String, maintainerCanModify: Option[Boolean], headers: Map[String, String]): F[GHResponse[PullRequest]]

Create a pull request

Create a pull request

Value Params
base

The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that

head

The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

headers

Optional user headers to include in the request

maintainerCanModify

Indicates whether maintainers can modify the pull request, Default:Some(true).

newPullRequest

The title and body parameters or the issue parameter

owner

Owner of the repo

repo

Name of the repo

def createReview(owner: String, repo: String, pullRequest: Int, createPRReviewRequest: CreatePRReviewRequest, headers: Map[String, String]): F[GHResponse[PullRequestReview]]

Create a review for a pull request

Create a review for a pull request

Value Params
createPRReviewRequest

Data to create a review

headers

Optional user header to include in the request

owner

Owner of the repo

pullRequest

ID number of the PR to get reviews for

repo

Name of the repo

Returns

a GHResponse with the created review

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

Get a single pull request for a repository

Get a single pull request for a repository

Value Params
headers

optional user headers to include in the request

number

of the pull request

owner

of the repo

repo

name of the repo

Returns

a GHResponse with the pull request.

def getReview(owner: String, repo: String, pullRequest: Int, review: Long, headers: Map[String, String]): F[GHResponse[PullRequestReview]]

Get a specific pull request review.

Get a specific pull request review.

Value Params
headers

Optional user header to include in the request

owner

Owner of the repo

pullRequest

ID number of the PR to get reviews for

repo

Name of the repo

review

ID number of the review to retrieve.

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

List files for a specific pull request

List files for a specific pull request

Value Params
headers

optional user headers to include in the request

number

of the pull request for which we want to list the files

owner

of the repo

pagination

Limit and Offset for pagination

repo

name of the repo

Returns

a GHResponse with the list of files affected by the pull request identified by number.

def listPullRequests(owner: String, repo: String, filters: List[PRFilter], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PullRequest]]]

List pull requests for a repository

List pull requests for a repository

Value Params
filters

define the filter list. Options are:

  • state: Either open, closed, or all to filter by state. Default: open
  • head: Filter pulls by head user and branch name in the format of user:ref-name. Example: github:new-script-format.
  • base: Filter pulls by base branch name. Example: gh-pages.
  • sort: What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month). Default: created
  • direction: The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.
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 pull request list.

def listReviewers(owner: String, repo: String, pullRequest: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[ReviewersResponse]]
def listReviews(owner: String, repo: String, pullRequest: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PullRequestReview]]]

List pull request reviews.

List pull request reviews.

Value Params
headers

Optional user header to include in the request

owner

Owner of the repo

pagination

Limit and Offset for pagination

pullRequest

ID number of the PR to get reviews for.

repo

Name of the repo

def removeReviewers(owner: String, repo: String, pullRequest: Int, reviewers: ReviewersRequest, headers: Map[String, String]): F[GHResponse[PullRequest]]