request

type AssignIPAddressRequest struct {
	XMLName xml.Name `xml:"ip_address"`

	Access     string `xml:"access"`
	Family     string `xml:"family,omitempty"`
	ServerUUID string `xml:"server"`
}

type AttachStorageRequest struct {
	XMLName    xml.Name `xml:"storage_device"`
	ServerUUID string   `xml:"-"`

	Type        string `xml:"type,omitempty"`
	Address     string `xml:"address,omitempty"`
	StorageUUID string `xml:"storage,omitempty"`
}

type CloneStorageRequest struct {
	XMLName xml.Name `xml:"storage"`
	UUID    string   `xml:"-"`

	Zone  string `xml:"zone"`
	Tier  string `xml:"tier,omitempty"`
	Title string `xml:"title"`
}

type CreateBackupRequest struct {
	XMLName xml.Name `xml:"storage"`
	UUID    string   `xml:"-"`

	Title string `xml:"title"`
}

type CreateFirewallRuleRequest struct {
	upcloud.FirewallRule

	XMLName    xml.Name `xml:"firewall_rule"`
	ServerUUID string   `xml:"-"`
}

type CreateServerIPAddress struct {
	Access string `xml:"access"`
	Family string `xml:"family"`
}

type CreateServerRequest struct {
	XMLName xml.Name `xml:"server"`

	AvoidHost  string `xml:"avoid_host,omitempty"`
	BootOrder  string `xml:"boot_order,omitempty"`
	CoreNumber int    `xml:"core_number,omitempty"`
	// TODO: Convert to boolean
	Firewall         string                              `xml:"firewall,omitempty"`
	Hostname         string                              `xml:"hostname"`
	IPAddresses      []CreateServerIPAddress             `xml:"ip_addresses>ip_address"`
	LoginUser        *LoginUser                          `xml:"login_user,omitempty"`
	MemoryAmount     int                                 `xml:"memory_amount,omitempty"`
	PasswordDelivery string                              `xml:"password_delivery,omitempty"`
	Plan             string                              `xml:"plan,omitempty"`
	StorageDevices   []upcloud.CreateServerStorageDevice `xml:"storage_devices>storage_device"`
	TimeZone         string                              `xml:"timezone,omitempty"`
	Title            string                              `xml:"title"`
	UserData         string                              `xml:"user_data,omitempty"`
	VideoModel       string                              `xml:"video_model,omitempty"`
	// TODO: Convert to boolean
	VNC         string `xml:"vnc,omitempty"`
	VNCPassword string `xml:"vnc_password,omitempty"`
	Zone        string `xml:"zone"`
}

type CreateStorageRequest struct {
	XMLName xml.Name `xml:"storage"`

	Size       int                 `xml:"size"`
	Tier       string              `xml:"tier,omitempty"`
	Title      string              `xml:"title"`
	Zone       string              `xml:"zone"`
	BackupRule *upcloud.BackupRule `xml:"backup_rule,omitempty"`
}

type CreateTagRequest struct {
	upcloud.Tag

	XMLName xml.Name `xml:"tag"`
}

type DeleteFirewallRuleRequest struct {
	ServerUUID string
	Position   int
}

type DeleteServerAndStoragesRequest struct {
	UUID string
}

type DeleteServerRequest struct {
	UUID string
}

type DeleteStorageRequest struct {
	UUID string
}

type DeleteTagRequest struct {
	Name string
}

type DetachStorageRequest struct {
	XMLName    xml.Name `xml:"storage_device"`
	ServerUUID string   `xml:"-"`

	Address string `xml:"address"`
}

type EjectCDROMRequest struct {
	ServerUUID string
}

type GetFirewallRuleDetailsRequest struct {
	ServerUUID string
	Position   int
}

type GetFirewallRulesRequest struct {
	ServerUUID string
}

type GetIPAddressDetailsRequest struct {
	Address string
}

type GetServerDetailsRequest struct {
	UUID string
}

type GetStorageDetailsRequest struct {
	UUID string
}

type GetStoragesRequest struct {
	// If specified, only storages with this access type will be retrieved
	Access string
	// If specified, only storages with this type will be retrieved
	Type string
	// If specified, only storages marked as favorite will be retrieved
	Favorite bool
}

type LoadCDROMRequest struct {
	XMLName    xml.Name `xml:"storage_device"`
	ServerUUID string   `xml:"-"`

	StorageUUID string `xml:"storage"`
}

type LoginUser struct {
	CreatePassword string   `xml:"create_password,omitempty"`
	Username       string   `xml:"username,omitempty"`
	SSHKeys        []string `xml:"ssh_keys>ssh_key,omitempty"`
}

type ModifyIPAddressRequest struct {
	XMLName   xml.Name `xml:"ip_address"`
	IPAddress string   `xml:"-"`

	PTRRecord string `xml:"ptr_record"`
}

type ModifyServerRequest struct {
	XMLName xml.Name `xml:"server"`

	UUID string `xml:"-"`

	AvoidHost string `xml:"avoid_host,omitempty"`
	BootOrder string `xml:"boot_order,omitempty"`
	// TODO: Investigate correct type and format
	CoreNumber string `xml:"core_number,omitempty"`
	// TODO: Convert to boolean
	Firewall string `xml:"firewall,omitempty"`
	Hostname string `xml:"hostname,omitempty"`
	// TODO: Investigate correct type and format
	MemoryAmount string `xml:"memory_amount,omitempty"`
	Plan         string `xml:"plan,omitempty"`
	TimeZone     string `xml:"timezone,omitempty"`
	Title        string `xml:"title,omitempty"`
	VideoModel   string `xml:"video_model,omitempty"`
	// TODO: Convert to boolean
	VNC         string `xml:"vnc,omitempty"`
	VNCPassword string `xml:"vnc_password,omitempty"`
}

type ModifyStorageRequest struct {
	XMLName xml.Name `xml:"storage"`
	UUID    string   `xml:"-"`

	Title      string              `xml:"title,omitempty"`
	Size       int                 `xml:"size,omitempty"`
	BackupRule *upcloud.BackupRule `xml:"backup_rule,omitempty"`
}

type ModifyTagRequest struct {
	upcloud.Tag

	XMLName xml.Name `xml:"tag"`
	Name    string   `xml:"-"`
}

type ReleaseIPAddressRequest struct {
	IPAddress string
}

type Request interface {
	// RequestURL returns the relative API URL for the request, excluding the API version.
	RequestURL() string
}

type RestartServerRequest struct {
	XMLName xml.Name `xml:"restart_server"`

	UUID string `xml:"-"`

	StopType      string        `xml:"stop_type,omitempty"`
	Timeout       time.Duration `xml:"timeout,omitempty"`
	TimeoutAction string        `xml:"timeout_action,omitempty"`
}

type RestoreBackupRequest struct {
	UUID string
}

type StartServerRequest struct {
	UUID string

	// TODO: Start server requests have no timeout in the API
	Timeout time.Duration
}

type StopServerRequest struct {
	XMLName xml.Name `xml:"stop_server"`

	UUID string `xml:"-"`

	StopType string        `xml:"stop_type,omitempty"`
	Timeout  time.Duration `xml:"timeout,omitempty"`
}

type TagServerRequest struct {
	UUID string
	Tags []string
}

type TemplatizeStorageRequest struct {
	XMLName xml.Name `xml:"storage"`
	UUID    string   `xml:"-"`

	Title string `xml:"title"`
}

type UntagServerRequest struct {
	UUID string
	Tags []string
}

type WaitForServerStateRequest struct {
	UUID           string
	DesiredState   string
	UndesiredState string
	Timeout        time.Duration
}

type WaitForStorageStateRequest struct {
	UUID         string
	DesiredState string
	Timeout      time.Duration
}