Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

6.  def createRelease(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, tagName: String, name: String, body: String, targetCommitish: Option[String] = None, draft: Option[Boolean] = None, prerelease: Option[Boolean] = None): M[GHResponse[Release]]

   Create a new release

   Create a new release

   accessToken

   to identify the authenticated user

   headers

   optional user headers to include in the request

   owner

   of the repo

   repo

   name of the repo

   tagName

   the name of the tag.

   name

   the name of the release.

   body

   text describing the contents of the tag.

   targetCommitish

   specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

   draft

   true to create a draft (unpublished) release, false to createStatus a published one. Default: false

   prerelease

   true to identify the release as a prerelease. false to identify the release as a full release. Default: false

   returns

   a GHResponse with Release

7.  def createStatus(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, sha: String, state: String, target_url: Option[String], description: Option[String], context: Option[String]): M[GHResponse[Status]]

   Create a status

   Create a status

   accessToken

   to identify the authenticated user

   headers

   optional user headers to include in the request

   owner

   of the repo

   repo

   name of the repo

   sha

   commit sha to create the status on

   state

   of the status: pending, success, error, or failure

   target_url

   url to associate with the status, will appear in the GitHub UI

   description

   of the status

   context

   identifier of the status maker

   returns

   a GHResopnse with the created Status

8.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

9.  def equals(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

10.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

11.  def get(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String): M[GHResponse[Repository]]

    Get information of a particular repository

    Get information of a particular repository

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    returns

    GHResponse[Repository] repository details

12.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

13.  def getContents(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, path: String, ref: Option[String] = None): M[GHResponse[NonEmptyList[Content]]]

    Get the contents of a file or directory in a repository.

    Get the contents of a file or directory in a repository.

    The response could be a:

    • file
    • directory The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file".
    • symlink If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.
    • submodule The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the github.com URLs (html_url and _links["html"]) will have null values

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    path

    the content path

    ref

    the name of the commit/branch/tag. Default: the repository’s default branch (usually master)

    returns

    GHResponse with the content defails

14.  def getStatus(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String): M[GHResponse[CombinedStatus]]

    Get the combined status for a specific ref

    Get the combined status for a specific ref

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the commit

    ref

    commit SHA, branch name or tag name

    returns

    a GHResponse with the combined status

15.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

16.  val httpClient: HttpClient[C, M]
17.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

18.  def listBranches(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, onlyProtected: Option[Boolean] = None): M[GHResponse[List[Branch]]]

    Retrieve list of branches for a repo

    Retrieve list of branches for a repo

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    onlyProtected

    Setting to true returns only protected branches

    returns

    GHResponse[List[Branch]\] List of branches

19.  def listCollaborators(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, affiliation: Option[String] = None): M[GHResponse[List[User]]]

    Fetch list of collaborators for the specified repository.

    Fetch list of collaborators for the specified repository. For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    affiliation

    Filter collaborators returned by their affiliation. Can be one of outside, direct, all. Default: all

    returns

    GHResponse[List[User]\] List of collaborators within the specified repository

20.  def listCommits(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, sha: Option[String] = None, path: Option[String] = None, author: Option[String] = None, since: Option[String] = None, until: Option[String] = None, pagination: Option[Pagination] = Some(httpClient.defaultPagination)): M[GHResponse[List[Commit]]]

    Retrieve the list of commits for a particular repo

    Retrieve the list of commits for a particular repo

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    sha

    branch to start listing commits from

    path

    commits containing this file path will be returned

    author

    GitHub login or email address by which to filter by commit author.

    since

    Only commits after this date will be returned

    until

    Only commits before this date will be returned

    pagination

    Limit and Offset for pagination

    returns

    GHResponse[List[Commit]\] List of commit's details

21.  def listContributors(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, anon: Option[String] = None): M[GHResponse[List[User]]]

    Fetch contributors list for the the specified repository, sorted by the number of commits per contributor in descending order.

    Fetch contributors list for the the specified repository, sorted by the number of commits per contributor in descending order.

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    anon

    Set to 1 or true to include anonymous contributors in results

    returns

    GHResponse[List[User]\] List of contributors associated with the specified repository.

22.  def listOrgRepos(accessToken: Option[String] = None, headers: Map[String, String] = Map(), org: String, type: Option[String] = None, pagination: Option[Pagination] = Some(httpClient.defaultPagination)): M[GHResponse[List[Repository]]]

    List the repositories for a particular organization

    List the repositories for a particular organization

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    org

    organization for which we wish to retrieve the repositories

    returns

    GHResponse[List[Repository]] the list of repositories for this organization

23.  def listStatuses(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, ref: String): M[GHResponse[List[Status]]]

    List statuses for a commit

    List statuses for a commit

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    ref

    commit SHA, branch name or tag name

    returns

    a GHResponse with the status list

24.  def listUserRepos(accessToken: Option[String] = None, headers: Map[String, String] = Map(), user: String, type: Option[String] = None, pagination: Option[Pagination] = Some(httpClient.defaultPagination)): M[GHResponse[List[Repository]]]

    List the repositories for a particular user

    List the repositories for a particular user

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    user

    user for which we wish to retrieve the repositories

    returns

    GHResponse[List[Repository]] the list of repositories for this user

25.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

26.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

27.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

28.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

29.  def toString(): String

    Definition Classes

    AnyRef → Any

30.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )