lib

type APIError struct {
	Method       string
	URL          *url.URL
	StatusCode   int
	RequestBody  string
	ResponseBody string
}

type Account struct {
	Name             string          `json:"name"`
	Owner            *billing.Person `json:"owner"`
	TechnicalContact *billing.Person `json:"technical_contact"`
	BillingID        int             `json:"billing_id"`
	BrainID          int             `json:"brain_id"`
	CardReference    string          `json:"card_reference"`
	Groups           []*brain.Group  `json:"groups"`
	Suspended        bool            `json:"suspended"`

	IsDefaultAccount bool `json:"-"`
}

type AccountCreationDeferredError struct{}

type AmbiguousKeyError struct {
	APIError
}

type BadNameError struct {
	APIError
	Type         string
	ProblemField string
	ProblemValue string
}

type BadRequestError struct {
	APIError
	Problems map[string][]string
}

type Client interface {

	// GetEndpoint returns the API endpoint currently in use.
	GetEndpoint() string

	// GetSessionFactors returns the factors provided when the current auth session was set up
	GetSessionFactors() []string
	// GetSessionToken returns the token for the current auth session
	GetSessionToken() string

	// GetSessionUser returns the user's name for the current auth session.
	GetSessionUser() string

	// SetDebugLevel sets the debug level / verbosity of the API client. 0 (default) is silent.
	SetDebugLevel(int)

	EnsureVirtualMachineName(vm *VirtualMachineName) error
	EnsureGroupName(group *GroupName) error
	EnsureAccountName(account *string) error

	// AuthWithToken attempts to read sessiondata from auth for the given token. Returns nil on success or an error otherwise.
	AuthWithToken(string) error
	// AuthWithCredentials attempts to authenticate with the given credentials. Returns nil on success or an error otherwise.
	AuthWithCredentials(auth3.Credentials) error

	AllowInsecureRequests()
	BuildRequestNoAuth(method string, endpoint Endpoint, path string, parts ...string) (*Request, error)
	BuildRequest(method string, endpoint Endpoint, path string, parts ...string) (*Request, error)

	CreateCreditCard(*spp.CreditCard) (string, error)
	CreateCreditCardWithToken(*spp.CreditCard, string) (string, error)

	// CreateAccount(*Account) (*Account, error) // TODO(telyn): figure out if CreateAccount is needed/useful
	GetSPPToken(cc spp.CreditCard, owner *billing.Person) (string, error)
	RegisterNewAccount(acc *Account) (*Account, error)

	ParseVirtualMachineName(string, ...*VirtualMachineName) (*VirtualMachineName, error)
	ParseGroupName(string, ...*GroupName) *GroupName
	ParseAccountName(string, ...string) string

	//
	// DEFINITIONS
	//
	ReadDefinitions() (*Definitions, error)

	// GetAccount takes an account name or ID and returns a filled-out Account object
	GetAccount(name string) (account *Account, err error)
	// GetDefaultAccount gets the most-likely default account for the user.
	GetDefaultAccount() (account *Account, err error)
	// GetAccounts gets all the accounts the logged-in user can see.
	GetAccounts() (accounts []*Account, err error)

	CreateDisc(vm *VirtualMachineName, disc brain.Disc) error
	DeleteDisc(vm *VirtualMachineName, idOrLabel string) error
	GetDisc(vm *VirtualMachineName, idOrLabel string) (*brain.Disc, error)
	ResizeDisc(vm *VirtualMachineName, idOrLabel string, size int) error
	SetDiscIopsLimit(vm *VirtualMachineName, idOrLabel string, iopsLimit int) error

	// CreateGroup sends a request to the API server to create a group with the given name.
	CreateGroup(name *GroupName) error
	DeleteGroup(name *GroupName) error
	GetGroup(name *GroupName) (*brain.Group, error)

	AddIP(name *VirtualMachineName, ipcr *brain.IPCreateRequest) (brain.IPs, error)

	//
	// PRIVILEGES
	//
	// username is allowed to be empty
	GetPrivileges(username string) (brain.Privileges, error)
	GetPrivilegesForAccount(account string) (brain.Privileges, error)
	GetPrivilegesForGroup(group GroupName) (brain.Privileges, error)
	GetPrivilegesForVirtualMachine(vm VirtualMachineName) (brain.Privileges, error)
	GrantPrivilege(p brain.Privilege) error
	RevokePrivilege(p brain.Privilege) error

	CreateBackup(server VirtualMachineName, discLabelOrID string) (brain.Backup, error)
	DeleteBackup(server VirtualMachineName, discLabelOrID string, backupLabelOrID string) error
	GetBackups(server VirtualMachineName, discLabelOrID string) (brain.Backups, error)
	RestoreBackup(server VirtualMachineName, discLabelOrID string, backupLabelOrID string) (brain.Backup, error)

	CreateBackupSchedule(server VirtualMachineName, discLabel string, startDate string, intervalSeconds int) (brain.BackupSchedule, error)
	DeleteBackupSchedule(server VirtualMachineName, discLabel string, id int) error

	GetUser(name string) (*brain.User, error)
	AddUserAuthorizedKey(username, key string) error
	DeleteUserAuthorizedKey(username, key string) error

	// CreateVirtualMachine creates a virtual machine with a given specification in the given group.
	// returns nil on success or an error otherwise.
	CreateVirtualMachine(group *GroupName, vm brain.VirtualMachineSpec) (*brain.VirtualMachine, error)

	// DeleteVirtualMachine deletes the named virtual machine.
	// returns nil on success or an error otherwise.
	DeleteVirtualMachine(name *VirtualMachineName, purge bool) error

	// GetVirtualMachine requests an overview of the named VM, regardless of its deletion status.
	GetVirtualMachine(name *VirtualMachineName) (*brain.VirtualMachine, error)

	// MoveVirtualMachine moves a server from one VirtualMachineName to another.
	MoveVirtualMachine(old *VirtualMachineName, new *VirtualMachineName) error

	// ReimageVirtualMachine reimages the named virtual machine. This will wipe everything on the first disk in the vm and install a new OS on top of it.
	// Note that the machine in question must already be powered off. Once complete, according to the API docs, the vm will be powered on but its autoreboot_on will be false.
	ReimageVirtualMachine(name *VirtualMachineName, image *brain.ImageInstall) (err error)

	// ResetVirtualMachine resets the named virtual machine. This is like pressing the reset
	// button on a physical computer. This does not cause a new process to be started, so does not apply any pending hardware changes.
	// returns nil on success or an error otherwise.
	ResetVirtualMachine(name *VirtualMachineName) (err error)

	// RestartVirtualMachine restarts the named virtual machine. This is
	// returns nil on success or an error otherwise.
	RestartVirtualMachine(name *VirtualMachineName) (err error)

	// StartVirtualMachine starts the named virtual machine.
	// returns nil on success or an error otherwise.
	StartVirtualMachine(name *VirtualMachineName) (err error)

	// StopVirtualMachine starts the named virtual machine.
	// returns nil on success or an error otherwise.
	StopVirtualMachine(name *VirtualMachineName) (err error)

	// ShutdownVirtualMachine sends an ACPI shutdown to the VM. This will cause a graceful shutdown of the machine
	// returns nil on success or an error otherwise.
	ShutdownVirtualMachine(name *VirtualMachineName, stayoff bool) (err error)

	// UndeleteVirtualMachine changes the deleted flag on a VM back to false.
	// Return nil on success, an error otherwise.
	UndeleteVirtualMachine(name *VirtualMachineName) error

	// SetVirtualMachineHardwareProfile specifies the hardware profile on a VM. Optionally locks or unlocks h. profile
	// Return nil on success, an error otherwise.
	SetVirtualMachineHardwareProfile(name *VirtualMachineName, profile string, locked ...bool) (err error)

	// SetVirtualMachineHardwareProfileLock locks or unlocks the hardware profile of a VM.
	// Return nil on success, an error otherwise.
	SetVirtualMachineHardwareProfileLock(name *VirtualMachineName, locked bool) (err error)

	// SetVirtualMachineMemory sets the RAM available to a virtual machine in megabytes
	// Return nil on success, an error otherwise.
	SetVirtualMachineMemory(name *VirtualMachineName, memory int) (err error)

	// SetVirtualMachineCores sets the number of CPUs available to a virtual machine
	// Return nil on success, an error otherwise.
	SetVirtualMachineCores(name *VirtualMachineName, cores int) (err error)

	// SetVirtualMachineCDROM sets the URL of a CD to attach to a virtual machine. Set url to "" to remove the CD.
	// Returns nil on success, an error otherwise.
	SetVirtualMachineCDROM(name *VirtualMachineName, url string) (err error)

	GetVLANs() ([]*brain.VLAN, error)
	GetVLAN(num int) (*brain.VLAN, error)
	GetIPRanges() ([]*brain.IPRange, error)
	GetIPRange(idOrCIDR string) (*brain.IPRange, error)
	GetHeads() ([]*brain.Head, error)
	GetHead(idOrLabel string) (*brain.Head, error)
	GetTails() ([]*brain.Tail, error)
	GetTail(idOrLabel string) (*brain.Tail, error)
	GetStoragePools() ([]*brain.StoragePool, error)
	GetStoragePool(idOrLabel string) (*brain.StoragePool, error)
	GetMigratingDiscs() ([]brain.Disc, error)
	GetMigratingVMs() ([]*brain.VirtualMachine, error)
	GetStoppedEligibleVMs() ([]*brain.VirtualMachine, error)
	GetRecentVMs() ([]*brain.VirtualMachine, error)
	MigrateDisc(disc int, newStoragePool string) error
	MigrateVirtualMachine(vmName VirtualMachineName, newHead string) error
	ReapVMs() error
	DeleteVLAN(id int) error
	AdminCreateGroup(name GroupName, vlanNum int) error
	CreateIPRange(ipRange string, vlanNum int) error
	CancelDiscMigration(id int) error
	CancelVMMigration(id int) error
	EmptyStoragePool(idOrLabel string) error
	EmptyHead(idOrLabel string) error
	ReifyDisc(id int) error
	ApproveVM(name VirtualMachineName, powerOn bool) error
	RejectVM(name VirtualMachineName, reason string) error
	RegradeDisc(disc int, newGrade string) error
	UpdateVMMigration(name VirtualMachineName, speed *int64, downtime *int) error
	CreateUser(username string, privilege string) error
	UpdateHead(idOrLabel string, options UpdateHead) error
	UpdateTail(idOrLabel string, options UpdateTail) error
	UpdateStoragePool(idOrLabel string, options UpdateStoragePool) error
}

type Definitions struct {
	Distributions            []string
	StorageGrades            []string
	ZoneNames                []string
	DistributionDescriptions map[string]string
	StorageGradeDescriptions map[string]string
	HardwareProfiles         []string
	Keymaps                  []string
	Sendkeys                 []string
}

type Endpoint int

type EndpointURLs struct {
	API     string
	Auth    string
	Billing string
	Brain   string
	SPP     string
}

type GroupName struct {
	Group   string
	Account string
}

type InsecureConnectionError struct {
	Request *Request
}

type InternalServerError struct {
	APIError
}

type JSONDefinition struct {
	ID   string          `json:"id"`
	Data json.RawMessage `json:"data"`
}

type JSONDefinitions []*JSONDefinition

type NilAuthError struct {
	APIError
}

type NoDefaultAccountError struct {
	InnerErr error
}

type NotAuthorizedError struct {
	APIError
}

type NotFoundError struct {
	APIError
}

type Overview struct {
	DefaultAccount *Account
	Username       string
	Accounts       []*Account
}

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

type RequestAlreadyRunError struct {
	Request *Request
}

type ServiceUnavailableError struct {
	APIError
}

type TemplateChoice string

type UnauthorizedError struct {
	APIError
}

type UnknownStatusCodeError struct {
	APIError
}

type UnsupportedEndpointError Endpoint

type UpdateHead struct {
	UsageStrategy   *string
	OvercommitRatio *int
	Label           *string
}

type UpdateStoragePool struct {
	UsageStrategy   *string
	OvercommitRatio *int
	Label           *string
}

type UpdateTail struct {
	UsageStrategy   *string
	OvercommitRatio *int
	Label           *string
}

type VirtualMachineName struct {
	VirtualMachine string
	Group          string
	Account        string
}