Github

Type Members

1. final case class Asset(id: Long, name: String, url: Uri, content: Option[String] = None) extends Product with Serializable

   

2. implicit final class BedazzledRequest extends AnyVal

   

3. final case class Branch(name: String, sha: Option[String] = None) extends Reference with Product with Serializable

   

4. final case class Contents(base64: String, name: String, size: Long) extends Product with Serializable

   

5. final case class DeleteRepoWebHook(slug: Slug, id: Long, token: AccessToken) extends GithubOp[Unit] with Product with Serializable

   

6. final case class Deployment(id: Long, ref: Reference, environment: String, deployables: List[Deployable], url: String) extends Product with Serializable

   

   https://developer.github.com/v3/repos/deployments/#response-1

7. final case class DeploymentEvent(slug: Slug, repositoryId: Long, deployment: Deployment) extends Event with Product with Serializable

   

   Reference: https://developer.github.com/v3/activity/events/types/#deploymentevent

8. sealed trait Event extends AnyRef

   

   Represents the events Nelson will recieve from Github (from webhooks).

9. final case class GetAccessToken(fromCode: String) extends GithubOp[AccessToken] with Product with Serializable

   

10. final case class GetDeployment(slug: Slug, id: Long, t: AccessToken) extends GithubOp[Option[Deployment]] with Product with Serializable

    

11. final case class GetFileFromRepository(slug: Slug, path: String, ref: Reference, t: AccessToken) extends GithubOp[Option[Contents]] with Product with Serializable

    

12. final case class GetOrganizations(keys: List[OrgKey], token: AccessToken) extends GithubOp[List[Organization]] with Product with Serializable

    

13. final case class GetRepoWebHooks(slug: Slug, token: AccessToken) extends GithubOp[List[WebHook]] with Product with Serializable

    

14. final case class GetUser(token: AccessToken) extends GithubOp[User] with Product with Serializable

    

15. final case class GetUserOrgKeys(token: AccessToken) extends GithubOp[List[OrgKey]] with Product with Serializable

    

16. final case class GetUserRepositories(token: AccessToken) extends GithubOp[List[Repo]] with Product with Serializable

    

17. final class GithubHttp extends ~>[GithubOp, IO]

    

18. sealed trait GithubOp[A] extends AnyRef

    

19. type GithubOpF[A] = Free[GithubOp, A]

    

20. final case class OrgKey(id: Long, slug: String) extends Product with Serializable

    

21. final case class PingEvent(zen: String) extends Event with Product with Serializable

    

    this is sent by github when the hook is initially setup, just to make sure that the specified location is actually reachable by github and is responding

22. final case class PostRepoWebHook(slug: Slug, hook: WebHook, t: AccessToken) extends GithubOp[WebHook] with Product with Serializable

    

23. final case class PullRequestEvent(id: Long, url: String, slug: Slug) extends Event with Product with Serializable

    

    Reference https://developer.github.com/v3/activity/events/types/#pullrequestevent

    Reference https://developer.github.com/v3/activity/events/types/#pullrequestevent

    This event definition is a placeholder for future support for inbound pull request deployments. This skeleton is being provided so that Nelson can parse the inbound payload and give a 200 OK response so Github doesn't think Nelson is faulty.

24. sealed trait Reference extends AnyRef

    

25. final case class Release(id: Long, url: String, htmlUrl: String, assets: List[Asset], tagName: String) extends Product with Serializable

    

26. final case class ReleaseEvent(id: Long, slug: Slug, repositoryId: Long) extends Event with Product with Serializable

    

    Reference: https://developer.github.com/v3/activity/events/types/#releaseevent

    Reference: https://developer.github.com/v3/activity/events/types/#releaseevent

    Nelson still accepts these as inbound input for historical reasons, so we simply accept it on the webhook entrypoint so that Github does not get invalid responses from Nelson (putting the webhook into an unsafe state).

27. final case class Sha(str: Sha256) extends Reference with Product with Serializable

    

28. final case class Tag(version: Version) extends Reference with Product with Serializable

    

29. final case class User(login: String, avatar: URI, name: Option[String], email: Option[String]) extends Product with Serializable

    

30. final case class WebHook(id: Long, name: String, events: List[String], active: Boolean, config: Map[String, String]) extends Product with Serializable