Packages

p

github4s

package github4s

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package algebras
  2. package domain
  3. package http
  4. package interpreters
  5. package modules

Type Members

  1. sealed abstract class GHError extends Exception

    Top-level exception returned by github4s when an error occurred.

  2. final case class GHResponse[A](result: Either[GHError, A], statusCode: Int, headers: Map[String, String]) extends Product with Serializable
  3. final case class GithubConfig(baseUrl: String, authorizeUrl: String, accessTokenUrl: String, headers: Map[String, String]) extends Product with Serializable

    Configuration for github4s

    Configuration for github4s

    baseUrl

    of the GitHub API. If you use GitHub enterprise, you'll need to modify this.

    authorizeUrl

    for the first step of the oAuth process. If you use GitHub enterprise, you'll need to modify this.

    accessTokenUrl

    for the second step of the oAuth process. If you use GitHub enterprise, you'll need to modify this.

    headers

    to add to all requests sent to the GitHub API. Defaults to "github4s" as user agent.

Deprecated Type Members

  1. class Github[F[_]] extends GithubClient[F]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.33.0) Use github4s.GithubClient instead

Value Members

  1. object Decoders

    Implicit circe decoders of domains objects

  2. object Encoders
  3. object GHError extends Serializable
  4. object Github
  5. object GithubClient
  6. object GithubConfig extends Serializable

Ungrouped