api

Documentation

Index

• Variables
• type Client
  • func NewClient(baseURL string, opts ...ClientOption) Client
  • func (cl Client) Request(ctx context.Context, method, url string, out interface{}) error
• type ClientOption
  • func WithAuthentication(token string) ClientOption
  • func WithHTTPClient(httpClient *http.Client) ClientOption

Variables

var ErrBadStatusCode = fmt.Errorf("bad status code")

Types

type Client

type Client struct {
	BaseURL string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(baseURL string, opts ...ClientOption) Client

NewClient returns a new Client with the given baseURL and options.

func (Client) Request

func (cl Client) Request(ctx context.Context, method, url string, out interface{}) error

type ClientOption

type ClientOption func(*Client)

func WithAuthentication

func WithAuthentication(token string) ClientOption

WithAuthentication returns a ClientOption that sets the token to be used for authentication. The token can be an API key, or it can be in the form of "username:password" for basic authentication.

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) ClientOption

WithHTTPClient returns a ClientOption that sets the HTTP client to be used.