api

package

v0.3.0 Latest Latest Go to latest Published: Dec 7, 2022 License: MIT Imports: 8 Imported by: 3

Details

Package api provides the functions to work with SiteHost API.

This section is empty.

This section is empty.

func CheckResponse(r *http.Response, data []byte) error

CheckResponse checks the API response for errors, and returns them if present.

A response is considered an error if it has a status code outside the 200 range or if the Status is false.

type Client struct {
	models.ClientBase
	// contains filtered or unexported fields
}

Client is a wrapper around the http client to manages communication with SiteHost API.

func New(apiKey, clientID string, opts ...ClientOpt) (*Client, error)

New returns a new SiteHost API client instance.

func NewClient(apiKey, clientID string) *Client

NewClient factory to create new Client struct.

func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) error

Do sends an API Request and returns the response.

The API response is checked to see if it was a successful call. A successful call is then checked to see if we have a Status true.

func (c *Client) NewRequest(method, uri string, body string) (*http.Request, error)

NewRequest creates an SiteHost API Request.

type ClientOpt func(*Client) error

ClientOpt function parameters to configure a Client.

func SetBaseURL(bu string) ClientOpt

SetBaseURL change the default BaseURL.

Path	Synopsis
job Package job represents our SiteHost `/job` endpoint	Package job represents our SiteHost `/job` endpoint
server Package server represents our SiteHost `/server` API endpoint.	Package server represents our SiteHost `/server` API endpoint.