github4s/github4s.domain

github4s.domain

package github4s.domain

Type members

Classlikes

final case class Authorize(url: String, state: String)
final case class BlobContent(url: String, sha: String, size: Int, content: Option[String], encoding: Option[String])
final case class Branch(name: String, commit: BranchCommit, `protected`: Option[Boolean], protection_url: Option[String])
final case class BranchCommit(sha: String, url: String)
final case class BranchUpdateRequest(expected_head_sha: Option[String])
final case class BranchUpdateResponse(message: String, url: String)
final case class Card(url: String, project_url: String, id: Long, node_id: String, archived: Boolean, creator: Creator, created_at: String, updated_at: String, column_url: String, note: Option[String], content_url: Option[String])
final case class Column(url: String, project_url: String, cards_url: String, id: Long, node_id: String, name: String, created_at: String, updated_at: String)
final case class CombinedStatus(url: String, state: String, commit_url: String, sha: String, total_count: Int, statuses: List[Status], repository: StatusRepository)
final case class Comment(id: Long, url: String, html_url: String, body: String, created_at: String, updated_at: String, user: Option[User])
final case class CommentData(body: String)
final case class Commit(sha: String, message: String, date: String, url: String, login: Option[String], avatar_url: Option[String], author_url: Option[String])
final case class Committer(name: String, email: String)
sealed abstract class ComparisonOperator(val value: String)
final case class Content(`type`: String, size: Int, name: String, path: String, sha: String, url: String, git_url: String, html_url: String, encoding: Option[String], target: Option[String], submodule_git_url: Option[String], content: Option[String], download_url: Option[String])
final case class CreatePRReviewRequest(commit_id: Option[String], body: String, event: PullRequestReviewEvent, comments: List[CreateReviewComment])
sealed trait CreatePullRequest
final case class CreatePullRequestData(title: String, head: String, base: String, body: String, maintainer_can_modify: Option[Boolean], draft: Boolean) extends CreatePullRequest
final case class CreatePullRequestIssue(issue: Int, head: String, base: String, maintainer_can_modify: Option[Boolean]) extends CreatePullRequest
final case class CreateReferenceRequest(ref: String, sha: String)
case class CreateReviewComment(path: String, position: Int, body: String)
final case class Creator(login: String, id: Long, node_id: String, avatar_url: String, url: String, html_url: String, followers_url: String, following_url: String, gists_url: String, starred_url: String, subscriptions_url: String, organizations_url: String, repos_url: String, events_url: String, received_events_url: String, `type`: String, site_admin: Boolean, gravatar_id: Option[String])
final case class DeleteFileRequest(message: String, sha: String, branch: Option[String], committer: Option[Committer], author: Option[Committer])
final case class EditGistFile(content: String, filename: Option[String])
final case class EditGistRequest(description: String, files: Map[String, Option[EditGistFile]])
final case class EditIssueRequest(state: String, title: String, body: String, labels: List[String], assignees: List[String], milestone: Option[Int])
final case class Gist(url: String, id: String, description: String, public: Boolean, files: Map[String, GistFile])
final case class GistFile(content: String)
case object GreaterThan extends ComparisonOperator
final case class Issue(id: Long, title: String, url: String, repository_url: String, labels_url: String, comments_url: String, events_url: String, html_url: String, number: Int, state: String, labels: List[Label], comments: Int, created_at: String, updated_at: String, body: Option[String], user: Option[User], assignee: Option[User], locked: Option[Boolean], pull_request: Option[IssuePullRequest], closed_at: Option[String])
final case class IssuePullRequest(url: Option[String], html_url: Option[String], diff_url: Option[String], patch_url: Option[String])
sealed trait IssueState extends SearchParam
case object IssueStateClosed extends IssueState
case object IssueStateOpen extends IssueState
sealed trait IssueType extends SearchParam
case object IssueTypeIssue extends IssueType
case object IssueTypePullRequest extends IssueType
final case class Label(name: String, color: String, id: Option[Long], description: Option[String], url: Option[String], default: Option[Boolean])
final case class LabelParam(label: String, exclude: Boolean) extends SearchParam
final case class LanguageParam(language: String) extends SearchParam
case object LesserThan extends ComparisonOperator
final case class Milestone(url: String, html_url: String, labels_url: String, id: Long, node_id: String, number: Int, state: String, title: String, description: String, creator: Creator, open_issues: Int, closed_issues: Int, created_at: String, updated_at: String, closed_at: Option[String], due_on: Option[String])
final case class MilestoneData(title: String, state: Option[String], description: Option[String], due_on: Option[ZonedDateTime])
final case class NewBlobRequest(content: String, encoding: Option[String])
final case class NewCommitRequest(message: String, tree: String, parents: List[String], author: Option[RefAuthor])
final case class NewGistRequest(description: String, public: Boolean, files: Map[String, GistFile])
final case class NewIssueRequest(title: String, body: String, labels: List[String], assignees: List[String], milestone: Option[Int])
sealed trait NewPullRequest
final case class NewPullRequestData(title: String, body: String, draft: Boolean) extends NewPullRequest
final case class NewPullRequestIssue(issue: Int) extends NewPullRequest
final case class NewReleaseRequest(tag_name: String, name: String, body: String, target_commitish: Option[String], draft: Option[Boolean], prerelease: Option[Boolean])
final case class NewStatusRequest(state: String, target_url: Option[String], description: Option[String], context: Option[String])
final case class NewTagRequest(tag: String, message: String, `object`: String, `type`: String, tagger: Option[RefAuthor])
final case class NewTreeRequest(tree: List[TreeData], base_tree: Option[String])
final case class OAuthToken(access_token: String, token_type: String, scope: String)
sealed trait OwnerParam extends SearchParam
final case class OwnerParamInRepository(repo: String) extends OwnerParam
final case class OwnerParamOwnedByUser(user: String) extends OwnerParam
sealed abstract class PRFilter(val name: String, val value: String) extends Product with Serializable
case object PRFilterAll extends PRFilterState
final case class PRFilterBase(value: String) extends PRFilter
case object PRFilterClosed extends PRFilterState
sealed abstract class PRFilterDirection(val value: String) extends PRFilter
final case class PRFilterHead(value: String) extends PRFilter
case object PRFilterOpen extends PRFilterState
case object PRFilterOrderAsc extends PRFilterDirection
case object PRFilterOrderDesc extends PRFilterDirection
sealed abstract class PRFilterSort(val value: String) extends PRFilter
case object PRFilterSortCreated extends PRFilterSort
case object PRFilterSortLongRunning extends PRFilterSort
case object PRFilterSortPopularity extends PRFilterSort
case object PRFilterSortUpdated extends PRFilterSort
sealed abstract class PRFilterState(val value: String) extends PRFilter
case object PRREventApprove extends PullRequestReviewEvent
case object PRREventComment extends PullRequestReviewEvent
case object PRREventPending extends PullRequestReviewEvent
case object PRREventRequestChanges extends PullRequestReviewEvent
case object PRRStateApproved extends PullRequestReviewState
case object PRRStateChangesRequested extends PullRequestReviewState
case object PRRStateCommented extends PullRequestReviewState
case object PRRStateDismissed extends PullRequestReviewState
case object PRRStatePending extends PullRequestReviewState
final case class Pagination(page: Int, per_page: Int)
final case class Project(owner_url: String, url: String, html_url: String, columns_url: String, id: Long, node_id: String, name: String, number: Int, creator: Creator, created_at: String, updated_at: String, body: Option[String], organization_permission: Option[String], `private`: Option[Boolean])
final case class PublicGitHubEvent(id: Long, `type`: String, actor_login: String, repo_full_name: String, public: Boolean, created_at: String)
final case class PullRequest(id: Long, number: Int, state: String, title: String, locked: Boolean, html_url: String, created_at: String, body: Option[String], updated_at: Option[String], closed_at: Option[String], merged_at: Option[String], merge_commit_sha: Option[String], base: Option[PullRequestBase], head: Option[PullRequestBase], user: Option[User], assignee: Option[User], draft: Boolean)
final case class PullRequestBase(ref: String, sha: String, label: Option[String], user: Option[User], repo: Option[Repository])
final case class PullRequestFile(sha: String, filename: String, status: String, additions: Int, deletions: Int, changes: Int, blob_url: String, raw_url: String, contents_url: String, patch: Option[String], previous_filename: Option[String])
final case class PullRequestReview(id: Long, body: String, commit_id: String, state: PullRequestReviewState, html_url: String, pull_request_url: String, user: Option[User])
sealed abstract class PullRequestReviewEvent(val value: String)
sealed abstract class PullRequestReviewState(val value: String)
final case class Ref(ref: String, node_id: String, url: String, `object`: RefObject)
final case class RefAuthor(date: String, name: String, email: String)
final case class RefCommit(sha: String, url: String, author: RefAuthor, committer: RefAuthor, message: String, tree: RefInfo, parents: List[RefInfo])
final case class RefInfo(sha: String, url: String) extends RefMetadata
sealed trait RefMetadata
final case class RefObject(`type`: String, sha: String, url: String) extends RefMetadata
final case class Release(id: Long, tag_name: String, target_commitish: String, name: String, body: String, draft: Boolean, prerelease: Boolean, created_at: String, url: String, html_url: String, assets_url: String, upload_url: String, published_at: Option[String], author: Option[User], tarball_url: Option[String], zipball_url: Option[String])
final case class RepoPermissions(admin: Boolean, push: Boolean, pull: Boolean)
final case class RepoStatus(size: Int, stargazers_count: Int, watchers_count: Int, forks_count: Int, open_issues_count: Int, has_issues: Boolean, has_downloads: Boolean, has_wiki: Boolean, has_pages: Boolean, open_issues: Option[Int], watchers: Option[Int], network_count: Option[Int], subscribers_count: Option[Int])
object RepoUrlKeys
final case class RepoUrls(url: String, html_url: String, git_url: String, ssh_url: String, clone_url: String, svn_url: String, otherUrls: Map[String, String])
final case class Repository(id: Long, name: String, full_name: String, owner: User, `private`: Boolean, fork: Boolean, archived: Boolean, urls: RepoUrls, created_at: String, updated_at: String, pushed_at: String, status: RepoStatus, default_branch: String, description: Option[String], homepage: Option[String], language: Option[String], organization: Option[User], parent: Option[RepositoryBase], permissions: Option[RepoPermissions], source: Option[RepositoryBase], topics: List[String])
Companion:
object
object Repository
Companion:
class
final case class RepositoryBase(id: Long, name: String, full_name: String, owner: User, `private`: Boolean, fork: Boolean, archived: Boolean, urls: RepoUrls, created_at: String, updated_at: String, pushed_at: String, status: RepoStatus, default_branch: String, description: Option[String], homepage: Option[String], language: Option[String], organization: Option[User], permissions: Option[RepoPermissions], topics: List[String])

A Repository but without any recursive definitions (parent and source)

A Repository but without any recursive definitions (parent and source)

final case class RepositoryMinimal(id: Long, node_id: String, name: String, full_name: String, `private`: Boolean, owner: User, html_url: String, description: Option[String], fork: Boolean, url: String, forks_url: String, keys_url: String, collaborators_url: String, teams_url: String, hooks_url: String, issue_events_url: String, events_url: String, assignees_url: String, branches_url: String, blobs_url: String, git_tags_url: String, git_refs_url: String, trees_url: String, statuses_url: String, languages_url: String, stargazers_url: String, contributors_url: String, subscribers_url: String, subscription_url: String, commits_url: String, git_commits_url: String, comments_url: String, issue_comment_url: String, contents_url: String, compare_url: String, merges_url: String, archive_url: String, downloads_url: String, issues_url: String, pulls_url: String, milestones_url: String, notifications_url: String, releases_url: String, deployments_url: String)

A Repository but with some information omitted (this is used by the search API)

A Repository but with some information omitted (this is used by the search API)

final case class ReviewersRequest(reviewers: List[String], team_reviewers: List[String])
final case class ReviewersResponse(users: List[User], teams: List[Team])
sealed trait SearchCodeParam
Companion:
object
object SearchCodeParam
Companion:
class
final case class SearchCodeResult(total_count: Int, incomplete_results: Boolean, items: List[SearchCodeResultItem])
final case class SearchCodeResultItem(name: String, path: String, sha: String, url: String, git_url: String, html_url: String, repository: RepositoryMinimal, score: Double, file_size: Option[Long], language: Option[String], last_modified_at: Option[String], line_numbers: Option[List[String]], text_matches: Option[List[SearchResultTextMatch]])
final case class SearchIn(values: Set[SearchInValue]) extends SearchParam
case object SearchInBody extends SearchInValue
case object SearchInComments extends SearchInValue
case object SearchInTitle extends SearchInValue
sealed trait SearchInValue
final case class SearchIssuesResult(total_count: Int, incomplete_results: Boolean, items: List[Issue])
sealed trait SearchParam
final case class SearchReposResult(total_count: Int, incomplete_results: Boolean, items: List[Repository])
final case class SearchResultTextMatch(object_url: String, object_type: Option[String], property: String, fragment: String, matches: List[SearchResultTextMatchLocation])
final case class SearchResultTextMatchLocation(text: String, indices: List[Int])
final case class Stargazer(user: User, starred_at: Option[String])
final case class StarredRepository(repo: Repository, starred_at: Option[String])
final case class Status(url: String, avatar_url: String, id: Long, node_id: String, state: String, created_at: String, updated_at: String, description: Option[String], target_url: Option[String], context: Option[String])
final case class StatusRepository(id: Long, name: String, full_name: String, `private`: Boolean, fork: Boolean, urls: Map[String, String], owner: Option[User], description: Option[String])
case object StrictlyGreaterThan extends ComparisonOperator
case object StrictlyLesserThan extends ComparisonOperator
final case class Subscription(subscribed: Boolean, ignored: Boolean, created_at: String, url: String, thread_url: String, reason: Option[String])
final case class SubscriptionRequest(subscribed: Boolean, ignored: Boolean)
final case class Tag(tag: String, sha: String, url: String, message: String, tagger: RefAuthor, `object`: RefObject)
final case class Team(id: Long, node_id: String, url: String, html_url: String, name: String, slug: String, privacy: String, permission: String, members_url: String, repositories_url: String, description: Option[String], parent: Option[Team])
final case class TopicParam(topic: String) extends SearchParam
sealed abstract class TreeData extends Product with Serializable
final case class TreeDataBlob(path: String, mode: String, `type`: String, content: String) extends TreeData
final case class TreeDataResult(path: String, mode: String, `type`: String, sha: String, url: String, size: Option[Int])
final case class TreeDataSha(path: String, mode: String, `type`: String, sha: String) extends TreeData
final case class TreeResult(sha: String, url: String, tree: List[TreeDataResult], truncated: Option[Boolean]) extends RefMetadata
final case class UpdateReferenceRequest(sha: String, force: Boolean)
final case class User(id: Long, login: String, avatar_url: String, html_url: String, name: Option[String], email: Option[String], company: Option[String], blog: Option[String], location: Option[String], bio: Option[String], followers_url: Option[String], following_url: Option[String], `type`: String, hireable: Option[Boolean], public_repos: Option[Int], contributions: Option[Int])
final case class UserRepoPermission(permission: String, user: User)
final case class WriteFileRequest(message: String, content: String, sha: Option[String], branch: Option[String], committer: Option[Committer], author: Option[Committer])
final case class WriteFileResponse(content: Option[Content], commit: WriteResponseCommit)
final case class WriteResponseCommit(sha: String, url: String, html_url: String, message: String, author: Option[Committer], committer: Option[Committer])