api

package

v0.4.0 Latest Latest Go to latest Published: Jul 17, 2024 License: MIT Imports: 8 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sitehostnz/gosh

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api provides the functions to work with SiteHost API.

Index ¶

func CheckResponse(r *http.Response, data []byte) error
type Client
- func New(apiKey, clientID string, opts ...ClientOpt) (*Client, error)
- func NewClient(apiKey, clientID string) *Client
- func (c *Client) Do(_ context.Context, req *http.Request, v interface{}) error
- func (c *Client) NewRequest(method, uri string, body string) (*http.Request, error)
type ClientOpt
- func SetBaseURL(bu string) ClientOpt

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckResponse ¶

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.

Types ¶

type Client ¶

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 ¶

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

New returns a new SiteHost API client instance.

func NewClient ¶

func NewClient(apiKey, clientID string) *Client

NewClient factory to create new Client struct.

func (*Client) Do ¶

func (c *Client) Do(_ 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 (*Client) NewRequest ¶

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

NewRequest creates an SiteHost API Request.

type ClientOpt ¶

type ClientOpt func(*Client) error

ClientOpt function parameters to configure a Client.

func SetBaseURL ¶

func SetBaseURL(bu string) ClientOpt

SetBaseURL change the default BaseURL (Include the API version).

Source Files ¶

View all Source files

client.go

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
bandwidth Package bandwidth represents the SiteHost `/bandwidth` API endpoint.	Package bandwidth represents the SiteHost `/bandwidth` API endpoint.
cloud
db Package db provides access to the `/cloud/db` API endpoint.	Package db provides access to the `/cloud/db` API endpoint.
db/grant Package grant is used for interacting with the SiteHost `/cloud/db/grant` API endpoint.	Package grant is used for interacting with the SiteHost `/cloud/db/grant` API endpoint.
db/user Package user represents the SiteHost `/cloud/db/user` API endpoint.	Package user represents the SiteHost `/cloud/db/user` API endpoint.
image Package image provides access to the `/cloud/image` API endpoint.	Package image provides access to the `/cloud/image` API endpoint.
server Package server provides access to the `/cloud/stack/server` API endpoint.	Package server provides access to the `/cloud/stack/server` API endpoint.
ssh/user Package user provides access to the `/cloud/ssh/user` API endpoint.	Package user provides access to the `/cloud/ssh/user` API endpoint.
stack Package stack represents a cloud stack operations under the `/cloud/stack` API endpoint.	Package stack represents a cloud stack operations under the `/cloud/stack` API endpoint.
stack/environment Package environment represents a cloud stack environment operations under the `/cloud/stack/environment` API endpoint.	Package environment represents a cloud stack environment operations under the `/cloud/stack/environment` API endpoint.
stack/image Package image provides access to the `/cloud/stack/image` API endpoint.	Package image provides access to the `/cloud/stack/image` API endpoint.
dns Package dns represents our SiteHost `/dns` API endpoint.	Package dns represents our SiteHost `/dns` API endpoint.
info Package info represents our SiteHost `/api` API endpoint.	Package info represents our SiteHost `/api` API endpoint.
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.
ssh
key Package key represents our SiteHost `/ssh/key` API endpoint.	Package key represents our SiteHost `/ssh/key` API endpoint.