internal

Documentation

Index

• Variables
• type Connection
  • func NewConnection(apiURL string, httpClient *http.Client, tracing bool) Connection
• type ForbiddenError
  • func (e ForbiddenError) Error() string
• type HTTPAgent
  • func NewHTTPAgent(apiURL string, httpClient *http.Client, tracing bool) HTTPAgent
• type Request
• type ResourceNotFoundError
  • func (e ResourceNotFoundError) Error() string
• type Response
• type UnexpectedResponseError
  • func (e UnexpectedResponseError) Error() string

Variables

var ErrForbidden = ForbiddenError{}

var ErrUnauthorized = errors.New("not authorized")

Types

type Connection

type Connection interface {
	URL() string
	HTTPClient() *http.Client

	Send(request Request, response *Response) error
	SendHTTPRequest(request *http.Request, returnResponseBody bool, response *Response) error
	ConnectToEventStream(request Request) (*sse.EventSource, error)
}

Deprecated. Use HTTPAgent instead

func NewConnection

func NewConnection(apiURL string, httpClient *http.Client, tracing bool) Connection

Deprecated

type ForbiddenError

type ForbiddenError struct {
	Reason string
	// contains filtered or unexported fields
}

func (ForbiddenError) Error

func (e ForbiddenError) Error() string

type HTTPAgent

type HTTPAgent interface {
	Send(request Request) (http.Response, error)
}

func NewHTTPAgent

func NewHTTPAgent(apiURL string, httpClient *http.Client, tracing bool) HTTPAgent

type Request

type Request struct {
	RequestName        string
	Params             rata.Params
	Query              url.Values
	Header             http.Header
	Body               io.Reader
	ReturnResponseBody bool
}

type ResourceNotFoundError

type ResourceNotFoundError jsonapi.ErrorsPayload

func (ResourceNotFoundError) Error

func (e ResourceNotFoundError) Error() string

type Response

type Response struct {
	Result  interface{}
	Headers *http.Header
	Created bool
}

type UnexpectedResponseError

type UnexpectedResponseError struct {
	StatusCode int
	Status     string
	Body       string
	// contains filtered or unexported fields
}

func (UnexpectedResponseError) Error

func (e UnexpectedResponseError) Error() string