api

Documentation

Index

• Variables
• type Client
  • func NewClient(config *Config) *Client
  • func (c *Client) Delete(path string, options ...Option) (*jnode.Node, error)
  • func (c *Client) Download(path string) ([]byte, error)
  • func (c *Client) Get(path string, options ...Option) (*jnode.Node, error)
  • func (c *Client) GetClient() *resty.Client
  • func (c *Client) GetHostURL() string
  • func (c *Client) GetOrganization() string
  • func (c *Client) GetWithParams(path string, params map[string]string, options ...Option) (*jnode.Node, error)
  • func (c *Client) Patch(path string, body *jnode.Node, options ...Option) (*jnode.Node, error)
  • func (c *Client) Post(path string, body *jnode.Node, options ...Option) (*jnode.Node, error)
  • func (c *Client) XCPPost(module string, files []string, values map[string]string, options ...Option) (*jnode.Node, error)
• type Config
  • func (c *Config) GetAppURL() string
  • func (c *Config) GetDomain() string
  • func (c *Config) SetValues() *Config
  • func (c *Config) Validate() error
• type Credentials
  • func (c Credentials) Find(profileName string) *ProfileCredentials
  • func (c Credentials) Save() error
• type Option
  • func CloseableOptionFunc(f func(req *resty.Request), close func() error) Option
  • func OptionFunc(f func(*resty.Request)) Option
• type ProfileCredentials
  • func (p *ProfileCredentials) IsNearExpiration() bool
  • func (p *ProfileCredentials) RefreshToken(domain string, keyID string, secretKey string) error

Variables

var ErrNoContent = errors.New("no content")

var HTTPError httpError

var UserAgent = "soluble-cli/" + version.Version

Types

type Client

type Client struct {
	*resty.Client
	Config
	NoOrganizationHook func() error
}

func NewClient

func NewClient(config *Config) *Client

func (*Client) Delete

func (c *Client) Delete(path string, options ...Option) (*jnode.Node, error)

func (*Client) Download

func (c *Client) Download(path string) ([]byte, error)

func (*Client) Get

func (c *Client) Get(path string, options ...Option) (*jnode.Node, error)

func (*Client) GetClient

func (c *Client) GetClient() *resty.Client

func (*Client) GetHostURL

func (c *Client) GetHostURL() string

func (*Client) GetOrganization

func (c *Client) GetOrganization() string

func (*Client) GetWithParams

func (c *Client) GetWithParams(path string, params map[string]string, options ...Option) (*jnode.Node, error)

func (*Client) Patch

func (c *Client) Patch(path string, body *jnode.Node, options ...Option) (*jnode.Node, error)

func (*Client) Post

func (c *Client) Post(path string, body *jnode.Node, options ...Option) (*jnode.Node, error)

func (*Client) XCPPost

func (c *Client) XCPPost(module string, files []string, values map[string]string, options ...Option) (*jnode.Node, error)

type Config

type Config struct {
	Organization               string
	OrganizationFromConfigFile bool
	LegacyAPIToken             string
	LaceworkAccount            string
	LaceworkAPIToken           string
	LaceworkAPIKey             string
	LaceworkAPISecret          string
	APIServer                  string
	APIPrefix                  string
	Debug                      bool
	TLSNoVerify                bool
	Timeout                    time.Duration
	RetryCount                 int
	RetryWaitSeconds           float64
	Headers                    []string
}

func (*Config) GetAppURL

func (c *Config) GetAppURL() string

func (*Config) GetDomain

func (c *Config) GetDomain() string

func (*Config) SetValues

func (c *Config) SetValues() *Config

func (*Config) Validate

func (c *Config) Validate() error

Verify that the configuration chosen is usuable In particular, verify that LW_ACCOUNT is the same, because otherwise Organization is likely to be wrong.

type Credentials

type Credentials map[string]*ProfileCredentials

func (Credentials) Find

func (c Credentials) Find(profileName string) *ProfileCredentials

func (Credentials) Save

func (c Credentials) Save() error

type Option

type Option interface {
	Apply(*resty.Request)
}

func CloseableOptionFunc

func CloseableOptionFunc(f func(req *resty.Request), close func() error) Option

func OptionFunc

func OptionFunc(f func(*resty.Request)) Option

type ProfileCredentials

type ProfileCredentials struct {
	Token     string    `json:"token"`
	ExpiresAt time.Time `json:"expiresAt"`
}

func (*ProfileCredentials) IsNearExpiration

func (p *ProfileCredentials) IsNearExpiration() bool

func (*ProfileCredentials) RefreshToken

func (p *ProfileCredentials) RefreshToken(domain string, keyID string, secretKey string) error