client

package

v1.1.0 Latest Latest Go to latest Published: Dec 23, 2023 License: BSD-3-Clause Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func New(endpoint, apiKey string) (_ api.Service, err error)

New creates a new API v1 client that implements the Service interface.

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

APIv1 implements the Service interface

func (c *APIv1) DeleteShortURL(ctx context.Context, id string) (err error)

func (s *APIv1) Do(req *http.Request, data interface{}, checkStatus bool) (rep *http.Response, err error)

Do executes an http request against the server, performs error checking, and deserializes the response data into the specified struct.

func (s *APIv1) NewRequest(ctx context.Context, method, path string, data interface{}, params *url.Values) (req *http.Request, err error)

func (c *APIv1) ShortURLInfo(ctx context.Context, id string) (out *api.ShortURL, err error)

func (c *APIv1) ShortURLList(ctx context.Context, page *api.PageQuery) (out *api.ShortURLList, err error)

func (c *APIv1) ShortenURL(ctx context.Context, in *api.LongURL) (out *api.ShortURL, err error)

func (c *APIv1) Status(ctx context.Context) (out *api.StatusReply, err error)

func (c *APIv1) Updates(ctx context.Context, id string) (_ <-chan *api.Click, err error)

TODO: figure out how to gracefully close the connection!

type StatusError struct {
	StatusCode int
	Reply      api.Reply
}

StatusError decodes an error response from the Service

func (e *StatusError) Error() string