hcloud

README

hcloud-sdk-go

This is the official go SDK for the helmut.cloud platform.
A more advanced documentation will follow.

Documentation

Index

• type Client
  • func New(config *ClientConfig) *Client
  • func (c *Client) Delete(url string) (*http.Response, []byte, *ErrorResponse)
  • func (c *Client) Get(url string) (*http.Response, []byte, *ErrorResponse)
  • func (c *Client) GetEndpoint(endpoint string) string
  • func (c *Client) Post(url string, payload interface{}) (*http.Response, []byte, *ErrorResponse)
  • func (c *Client) SetApi(api string)
  • func (c *Client) SetToken(token string)
• type ClientConfig
• type ErrorResponse
• type Login
  • func (l Login) String() string
• type Organization
  • func (o Organization) String() string
• type OrganizationMember
  • func (o OrganizationMember) String() string
• type Register
  • func (r Register) String() string
• type Token
  • func (t Token) String() string
• type User
  • func (u User) String() string
• type Version
  • func (v Version) String() string

Types

type Client

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

func New

func New(config *ClientConfig) *Client

func (*Client) Delete

func (c *Client) Delete(url string) (*http.Response, []byte, *ErrorResponse)

func (*Client) Get

func (c *Client) Get(url string) (*http.Response, []byte, *ErrorResponse)

func (*Client) GetEndpoint

func (c *Client) GetEndpoint(endpoint string) string

func (*Client) Post

func (c *Client) Post(url string, payload interface{}) (*http.Response, []byte, *ErrorResponse)

func (*Client) SetApi

func (c *Client) SetApi(api string)

func (*Client) SetToken

func (c *Client) SetToken(token string)

type ClientConfig

type ClientConfig struct {
	Api   string
	Token string
}

type ErrorResponse

type ErrorResponse struct {
	Code    int    `json:"status"`
	Message string `json:"message"`
}

ErrorReponse holds a code and a message parsed from an error resposne from the helmut.cloud platform

type Login

type Login struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

func (Login) String

func (l Login) String() string

type Organization

type Organization struct {
	Id      string `json:"_id,omitempty"`
	Name    string `json:"name,omitempty"`
	Creator User   `json:"creator,omitempty"`
	Company string `json:"company,omitempty"`
}

func (Organization) String

func (o Organization) String() string

type OrganizationMember

type OrganizationMember struct {
	Id             string   `json:"_id,omitempty"`
	OrganizationId string   `json:"organizationId,omitempty"`
	User           User     `json:"userDbRef,omitempty"`
	Roles          []string `json:"roles,omitempty"`
}

func (OrganizationMember) String

func (o OrganizationMember) String() string

type Register

type Register struct {
	Name     string `json:"name"`
	Company  string `json:"company,omitempty"`
	Email    string `json:"email"`
	Password string `json:"password"`
}

func (Register) String

func (r Register) String() string

type Token

type Token struct {
	Token string `json:"token"`
}

func (Token) String

func (t Token) String() string

type User

type User struct {
	Id      string `json:"_id,omitempty"`
	Name    string `json:"name,omitempty"`
	Email   string `json:"email,omitempty"`
	Company string `json:"company,omitempty"`
}

func (User) String

func (u User) String() string

type Version

type Version struct {
	Version string `json:"version"`
}

func (Version) String

func (v Version) String() string