class RepositoriesInterpreter[F[_]] extends Repositories[F]
- Alphabetic
- By Inheritance
- RepositoriesInterpreter
- Repositories
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RepositoriesInterpreter()(implicit arg0: Functor[F], client: HttpClient[F])
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() @HotSpotIntrinsicCandidate()
-
def
compareCommits(owner: String, repo: String, commitSha: String, baseSha: String, headers: Map[String, String] = Map()): F[GHResponse[CommitComparisonResponse]]
Compare any two commits in the same repository
Compare any two commits in the same repository
- owner
of the repo
- repo
name of the repo
- commitSha
commit to compare against base
- baseSha
the base to compare against
- headers
optional user headers to include in the request
- returns
GhResponse[CommitComparisonResponse] comparison result
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
createFile(owner: String, repo: String, path: String, message: String, content: Array[Byte], branch: Option[String], committer: Option[Committer], author: Option[Committer], headers: Map[String, String]): F[GHResponse[WriteFileResponse]]
Creates a new file in a repository.
Creates a new file in a repository.
- owner
of the repo
- repo
name of the repo
- path
the content path
- message
the message to be included in the commit.
- content
content in bytes, as they should be written to GitHub.
- branch
the branch name (defaults to the repository's default branch)
- committer
object containing information about the committer (filled in with authenticated user information if omitted)
- author
object containing information about the author (filled in with committer information if omitted)
- headers
optional user headers to include in the request
- returns
GHResponse[WriteFileResponse] with details about the content created and the commit
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
createRelease(owner: String, repo: String, tagName: String, name: String, body: String, targetCommitish: Option[String], draft: Option[Boolean], prerelease: Option[Boolean], headers: Map[String, String]): F[GHResponse[Release]]
Create a new release
Create a new release
- 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
main
).- 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
- headers
optional user headers to include in the request
- returns
a GHResponse with Release
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
createStatus(owner: String, repo: String, sha: String, state: String, target_url: Option[String], description: Option[String], context: Option[String], headers: Map[String, String]): F[GHResponse[Status]]
Create a status
Create a status
- 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
- headers
optional user headers to include in the request
- returns
a GHResopnse with the created Status
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
deleteFile(owner: String, repo: String, path: String, message: String, sha: String, branch: Option[String], committer: Option[Committer], author: Option[Committer], headers: Map[String, String]): F[GHResponse[WriteFileResponse]]
Deletes a file in a particular repo, resulting in a new commit.
Deletes a file in a particular repo, resulting in a new commit.
- owner
of the repo
- repo
name of the repo
- path
the content path
- message
the message to be included in the commit.
- sha
the blob sha of the file being replaced.
- branch
the branch name (defaults to the repository's default branch)
- committer
object containing information about the committer (filled in with authenticated user information if omitted)
- author
object containing information about the author (filled in with committer information if omitted)
- headers
optional user headers to include in the request
- returns
GHResponse[WriteFileResponse] with no content and details about the commit which was added.
- Definition Classes
- RepositoriesInterpreter → Repositories
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
get(owner: String, repo: String, headers: Map[String, String]): F[GHResponse[Repository]]
Get information of a particular repository
Get information of a particular repository
- owner
of the repo
- repo
name of the repo
- headers
optional user headers to include in the request
- returns
GHResponse[Repository] repository details
- Definition Classes
- RepositoriesInterpreter → Repositories
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getCombinedStatus(owner: String, repo: String, ref: String, headers: Map[String, String]): F[GHResponse[CombinedStatus]]
Get the combined status for a specific ref
Get the combined status for a specific ref
- owner
of the repo
- repo
name of the commit
- ref
commit SHA, branch name or tag name
- headers
optional user headers to include in the request
- returns
a GHResponse with the combined status
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
getContents(owner: String, repo: String, path: String, ref: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[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
- 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
main
ormain
)- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
GHResponse with the content details
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
getRelease(releaseId: Long, owner: String, repo: String, headers: Map[String, String]): F[GHResponse[Option[Release]]]
Get a single release
Get a single release
- releaseId
id of the release
- owner
of the repo
- repo
name of the repo
- headers
optional user headers to include in the request
- returns
a GHResponse with List[Release]
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
getRepoPermissionForUser(owner: String, repo: String, username: String, headers: Map[String, String]): F[GHResponse[UserRepoPermission]]
Get the repository permission of a collaborator
Get the repository permission of a collaborator
- owner
of the repo
- repo
name of the repo
- username
Github username
- headers
optional user headers to include in the request
- returns
a GHResponse with UserRepoPermission
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
latestRelease(owner: String, repo: String, headers: Map[String, String]): F[GHResponse[Option[Release]]]
Latest release
Latest release
- owner
of the repo
- repo
name of the repo
- headers
optional user headers to include in the request
- returns
a GHResponse with List[Release]
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listBranches(owner: String, repo: String, onlyProtected: Option[Boolean], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Branch]]]
Retrieve list of branches for a repo
Retrieve list of branches for a repo
- owner
of the repo
- repo
name of the repo
- onlyProtected
Setting to true returns only protected branches
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
GHResponse[List[Branch]\] List of branches
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listCollaborators(owner: String, repo: String, affiliation: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[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.
- 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
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
GHResponse[List[User]\] List of collaborators within the specified repository
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listCommits(owner: String, repo: String, sha: Option[String], path: Option[String], author: Option[String], since: Option[String], until: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Commit]]]
Retrieve the list of commits for a particular repo
Retrieve the list of commits for a particular repo
- 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
- headers
optional user headers to include in the request
- returns
GHResponse[List[Commit]\] List of commit's details
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listContributors(owner: String, repo: String, anon: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[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.
- owner
of the repo
- repo
name of the repo
- anon
Set to 1 or true to include anonymous contributors in results
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
GHResponse[List[User]\] List of contributors associated with the specified repository.
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listOrgRepos(org: String, type: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Repository]]]
List the repositories for a particular organization
List the repositories for a particular organization
- org
organization for which we wish to retrieve the repositories
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
GHResponse[List[Repository]] the list of repositories for this organization
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listReleases(owner: String, repo: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Release]]]
List of releases
List of releases
- owner
of the repo
- repo
name of the repo
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with List[Release]
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listStatuses(owner: String, repo: String, ref: String, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Status]]]
List statuses for a commit
List statuses for a commit
- owner
of the repo
- repo
name of the repo
- ref
commit SHA, branch name or tag name
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the status list
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
listUserRepos(user: String, type: Option[String], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[Repository]]]
List the repositories for a particular user
List the repositories for a particular user
- user
user for which we wish to retrieve the repositories
- headers
optional user headers to include in the request
- returns
GHResponse[List[Repository]] the list of repositories for this user
- Definition Classes
- RepositoriesInterpreter → Repositories
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
searchRepos(query: String, searchParams: List[SearchParam], pagination: Option[Pagination], headers: Map[String, String] = Map.empty): F[GHResponse[SearchReposResult]]
Search all repositories on GitHub.
Search all repositories on GitHub.
- query
The query string for the search.
- searchParams
List of search params.
- pagination
Limit and Offset for pagination
- headers
Optional headers to include in the request.
- returns
A GHResponse with the result of the search
- Definition Classes
- RepositoriesInterpreter → Repositories
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
updateFile(owner: String, repo: String, path: String, message: String, content: Array[Byte], sha: String, branch: Option[String], committer: Option[Committer], author: Option[Committer], headers: Map[String, String]): F[GHResponse[WriteFileResponse]]
Updates an existing file in a repository.
Updates an existing file in a repository.
- owner
of the repo
- repo
name of the repo
- path
the content path
- message
the message to be included in the commit.
- content
the content of the file as it should be written to GitHub
- sha
the blob sha of the file being replaced.
- branch
the branch name (defaults to the repository's default branch)
- committer
object containing information about the committer (filled in with authenticated user information if omitted)
- author
object containing information about the author (filled in with committer information if omitted)
- headers
optional user headers to include in the request
- returns
GHResponse[WriteFileResponse] with details about the content updated and the commit
- Definition Classes
- RepositoriesInterpreter → Repositories
-
def
userIsCollaborator(owner: String, repo: String, username: String, headers: Map[String, String]): F[GHResponse[Boolean]]
Get whether a user is a repository collaborator
Get whether a user is a repository collaborator
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.
- owner
of the repo
- repo
name of the repo
- username
Github username
- headers
optional user headers to include in the request
- returns
a Boolean GHResponse
- Definition Classes
- RepositoriesInterpreter → Repositories
-
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()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated