request

type Authorizer ¶

type Authorizer interface {
	AuthHeader() string
	RealtimeToken() string
}

Authorizer is an interface to represent any element that can be used as a token bearer.

type BasicAuthorizer ¶

type BasicAuthorizer struct {
	Username string
	Password string
}

BasicAuthorizer implements the HTTP basic auth for authorization.

func (b *BasicAuthorizer) AuthHeader() string

func (b *BasicAuthorizer) RealtimeToken() string

type BearerAuthorizer ¶

type BearerAuthorizer struct {
	Token string
}

BearerAuthorizer implements a placeholder authorizer if the token is already known.

func (b *BearerAuthorizer) AuthHeader() string

func (b *BearerAuthorizer) RealtimeToken() string

type Error ¶

type Error struct {
	Status string `json:"status"`
	Title  string `json:"title"`
	Detail string `json:"detail"`
}

Error is the typical JSON-API error returned by the API

func (e *Error) Error() string

type Headers ¶

type Headers map[string]string

Headers is a map of strings used to represent HTTP headers

type Options ¶

type Options struct {
	Addr          string
	Domain        string
	Scheme        string
	Method        string
	Path          string
	Queries       url.Values
	Headers       Headers
	Body          io.Reader
	Authorizer    Authorizer
	ContentLength int64
	NoResponse    bool

	DisableSecure bool
	Client        *http.Client
	UserAgent     string
	ParseError    func(res *http.Response, b []byte) error
}

Options is a struct holding of the details of a request.

The NoResponse field can be used in case the call's response if not used. In such cases, the response body is automatically closed.

type SSEEvent ¶

type SSEEvent struct {
	Name  string
	Data  []byte
	Error error
}

SSEEvent holds the data of a single SSE event.