http

Documentation

Index

• Variables
• type Client
  • func New(baseUrl string, authenticator auth.Authenticator, options *Options) *Client
  • func (c *Client) Delete(ctx context.Context, path string, response interface{}) error
  • func (c *Client) Get(ctx context.Context, path string, response interface{}) error
  • func (c *Client) Post(ctx context.Context, path string, request interface{}, response interface{}) error
  • func (c *Client) Put(ctx context.Context, path string, request interface{}, response interface{}) error
• type Options
• type SuccessResponse

Variables

var ErrNotFound = errors.New("not found")

var ErrUnsuccessfulResponse = errors.New("API returned an unsuccessful response. Check the API logs for more details")

Types

type Client

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

func New

func New(baseUrl string, authenticator auth.Authenticator, options *Options) *Client

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, path string, response interface{}) error

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, response interface{}) error

func (*Client) Post

func (c *Client) Post(ctx context.Context, path string, request interface{}, response interface{}) error

func (*Client) Put

func (c *Client) Put(ctx context.Context, path string, request interface{}, response interface{}) error

type Options

type Options struct {
	Timeout           time.Duration
	AdditionalHeaders map[string]string
}

type SuccessResponse

type SuccessResponse struct {
	Success bool `json:"success"`
}