trait PullRequests[F[_]] extends AnyRef
- Alphabetic
- By Inheritance
- PullRequests
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
createPullRequest(owner: String, repo: String, newPullRequest: NewPullRequest, head: String, base: String, maintainerCanModify: Option[Boolean] = Some(true), headers: Map[String, String] = Map()): F[GHResponse[PullRequest]]
Create a pull request
Create a pull request
- owner
Owner of the repo
- repo
Name of the repo
- newPullRequest
The title and body parameters or the issue parameter
- 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.
- 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
- maintainerCanModify
Indicates whether maintainers can modify the pull request, Default:Some(true).
- headers
Optional user headers to include in the request
-
abstract
def
getPullRequest(owner: String, repo: String, number: Int, headers: Map[String, String] = Map()): F[GHResponse[PullRequest]]
Get a single pull request for a repository
Get a single pull request for a repository
- owner
of the repo
- repo
name of the repo
- number
of the pull request
- headers
optional user headers to include in the request
- returns
a GHResponse with the pull request.
-
abstract
def
getReview(owner: String, repo: String, pullRequest: Int, review: Int, headers: Map[String, String] = Map()): F[GHResponse[PullRequestReview]]
Get a specific pull request review.
Get a specific pull request review.
- owner
Owner of the repo
- repo
Name of the repo
- pullRequest
ID number of the PR to get reviews for
- review
ID number of the review to retrieve.
- headers
Optional user header to include in the request
-
abstract
def
listFiles(owner: String, repo: String, number: Int, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[PullRequestFile]]]
List files for a specific pull request
List files for a specific pull request
- owner
of the repo
- repo
name of the repo
- number
of the pull request for which we want to list the files
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of files affected by the pull request identified by number.
-
abstract
def
listPullRequests(owner: String, repo: String, filters: List[PRFilter] = Nil, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[PullRequest]]]
List pull requests for a repository
List pull requests for a repository
- owner
of the repo
- repo
name of the repo
- filters
define the filter list. Options are:
- state: Either
open,closed, orallto 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) orlong-running(age, filtering by pulls updated in the last month). Default:created - direction: The direction of the sort. Can be either
ascordesc. Default:descwhen sort is created or sort is not specified, otherwiseasc.
- state: Either
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the pull request list.
-
abstract
def
listReviews(owner: String, repo: String, pullRequest: Int, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[PullRequestReview]]]
List pull request reviews.
List pull request reviews.
- owner
Owner of the repo
- repo
Name of the repo
- pullRequest
ID number of the PR to get reviews for.
- pagination
Limit and Offset for pagination
- headers
Optional user header to include in the request
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()