api

type API struct {
	Organization string     // Organization is the identifier of the  organization
	Token        string     // Token is the authentication token for the  organization
	Client       HTTPClient // Client is used for all HTTP interactions

	Region string
	// contains filtered or unexported fields
}

type APIError struct {
	// Message is a human-friendly error message
	APIMessage string `json:"message,omitempty"`

	// Type is a string code that defines the kind of error
	Type string `json:"type,omitempty"`

	// Fields contains detail about validation error
	Fields map[string][]string `json:"fields,omitempty"`

	// StatusCode is the HTTP status code received
	StatusCode int `json:"-"`

	// Message
	Message string `json:"-"`
}

type Bootscript struct {
	Bootcmdargs string `json:"bootcmdargs,omitempty"`
	Dtb         string `json:"dtb,omitempty"`
	Initrd      string `json:"initrd,omitempty"`
	Kernel      string `json:"kernel,omitempty"`

	// Arch is the architecture target of the bootscript
	Arch string `json:"architecture,omitempty"`

	// Identifier is a unique identifier for the bootscript
	Identifier string `json:"id,omitempty"`

	// Organization is the owner of the bootscript
	Organization string `json:"organization,omitempty"`

	// Name is a user-defined name for the bootscript
	Title string `json:"title,omitempty"`

	// Public is true for public bootscripts and false for user bootscripts
	Public bool `json:"public,omitempty"`

	Default bool `json:"default,omitempty"`
}

type Container struct {
	Organization `json:"organization"`
	Name         string `json:"name"`
	Size         string `json:"size"`
}

type ContainerData struct {
	LastModified string `json:"last_modified"`
	Name         string `json:"name"`
	Size         string `json:"size"`
}

type CreateTokenRequest struct {
	Email    string `json:"email"`
	Password string `json:"password,omitempty"`
	Expires  bool   `json:"expires"`
}

type Dashboard struct {
	VolumesCount        int `json:"volumes_count"`
	RunningServersCount int `json:"running_servers_count"`
	ImagesCount         int `json:"images_count"`
	SnapshotsCount      int `json:"snapshots_count"`
	ServersCount        int `json:"servers_count"`
	IPsCount            int `json:"ips_count"`
}

type DashboardResp struct {
	Dashboard Dashboard
}

type GetIP struct {
	IP IPV4 `json:"ip"`
}

type GetIPS struct {
	IPS []IPV4 `json:"ips"`
}

type GetQuotas struct {
	Quotas Quotas `json:"quotas"`
}

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type IPAddress struct {
	// Identifier is a unique identifier for the IP address
	Identifier string `json:"id,omitempty"`

	// IP is an IPv4 address
	IP string `json:"address,omitempty"`

	// Dynamic is a flag that defines an IP that change on each reboot
	Dynamic *bool `json:"dynamic,omitempty"`
}

type IPV4 struct {
	Organization string  `json:"organization"`
	Reverse      *string `json:"reverse"`
	ID           string  `json:"id"`
	Server       *struct {
		Identifier string `json:"id,omitempty"`
		Name       string `json:"name,omitempty"`
	} `json:"server"`
	Address string `json:"address"`
}

type IPV6 struct {
	Netmask string `json:"netmask"`
	Gateway string `json:"gateway"`
	Address string `json:"address"`
}

type Image struct {
	// Identifier is a unique identifier for the image
	Identifier string `json:"id,omitempty"`

	// Name is a user-defined name for the image
	Name string `json:"name,omitempty"`

	// CreationDate is the creation date of the image
	CreationDate string `json:"creation_date,omitempty"`

	// ModificationDate is the date of the last modification of the image
	ModificationDate string `json:"modification_date,omitempty"`

	// RootVolume is the root volume bound to the image
	RootVolume Volume `json:"root_volume,omitempty"`

	// Public is true for public images and false for user images
	Public bool `json:"public,omitempty"`

	// Bootscript is the bootscript bound to the image
	DefaultBootscript *Bootscript `json:"default_bootscript,omitempty"`

	// Organization is the owner of the image
	Organization string `json:"organization,omitempty"`

	// Arch is the architecture target of the image
	Arch string `json:"arch,omitempty"`
}

type ImageDefinition struct {
	SnapshotIDentifier string  `json:"root_volume"`
	Name               string  `json:"name,omitempty"`
	Organization       string  `json:"organization"`
	Arch               string  `json:"arch"`
	DefaultBootscript  *string `json:"default_bootscript,omitempty"`
}

type ImageIdentifier struct {
	Identifier string
	Arch       string
	Region     string
	Owner      string
}

type Images struct {
	// Images holds  images of the response
	Images []Image `json:"images,omitempty"`
}

type InstanceTypeAvailability string

type KeyDefinition struct {
	Key         string `json:"key"`
	Fingerprint string `json:"fingerprint,omitempty"`
}

type MarketImage struct {
	Categories           []string `json:"categories"`
	CreationDate         string   `json:"creation_date"`
	CurrentPublicVersion string   `json:"current_public_version"`
	Description          string   `json:"description"`
	ID                   string   `json:"id"`
	Logo                 string   `json:"logo"`
	ModificationDate     string   `json:"modification_date"`
	Name                 string   `json:"name"`
	Organization         struct {
		ID   string `json:"id"`
		Name string `json:"name"`
	} `json:"organization"`
	Public bool `json:"-"`
	MarketVersions
}

type MarketImages struct {
	Images []MarketImage `json:"images"`
}

type MarketLocalImage struct {
	LocalImages MarketLocalImageDefinition `json:"local_image"`
}

type MarketLocalImageDefinition struct {
	Arch string `json:"arch"`
	ID   string `json:"id"`
	Zone string `json:"zone"`
}

type MarketLocalImages struct {
	LocalImages []MarketLocalImageDefinition `json:"local_images"`
}

type MarketVersion struct {
	Version MarketVersionDefinition `json:"version"`
}

type MarketVersionDefinition struct {
	CreationDate string `json:"creation_date"`
	ID           string `json:"id"`
	Image        struct {
		ID   string `json:"id"`
		Name string `json:"name"`
	} `json:"image"`
	ModificationDate string `json:"modification_date"`
	Name             string `json:"name"`
	MarketLocalImages
}

type MarketVersions struct {
	Versions []MarketVersionDefinition `json:"versions"`
}

type NewSecurityGroup struct {
	Organization          string `json:"organization"`
	Name                  string `json:"name"`
	Description           string `json:"description"`
	EnableDefaultSecurity bool   `json:"enable_default_security"`
}

type NewSecurityGroupRule struct {
	Action       string `json:"action"`
	Direction    string `json:"direction"`
	IPRange      string `json:"ip_range"`
	Protocol     string `json:"protocol"`
	DestPortFrom int    `json:"dest_port_from,omitempty"`
}

type OneImage struct {
	Image Image `json:"image,omitempty"`
}

type OneServer struct {
	Server Server `json:"server,omitempty"`
}

type Organization struct {
	ID    string `json:"id"`
	Name  string `json:"name"`
	Users []User `json:"users"`
}

type PermCategory map[string][]string

type Permissions map[string]PermCategory

type Quotas map[string]int

type Role struct {
	Organization Organization `json:"organization,omitempty"`
	Role         string       `json:"role,omitempty"`
}

type SecurityGroup struct {
	Description           string      `json:"description"`
	ID                    string      `json:"id"`
	Organization          string      `json:"organization"`
	Name                  string      `json:"name"`
	Servers               []ServerRef `json:"servers"`
	EnableDefaultSecurity bool        `json:"enable_default_security"`
	OrganizationDefault   bool        `json:"organization_default"`
}

type SecurityGroupRef struct {
	Identifier string `json:"id,omitempty"`
	Name       string `json:"name,omitempty"`
}

type SecurityGroupRule struct {
	Direction    string `json:"direction"`
	Protocol     string `json:"protocol"`
	IPRange      string `json:"ip_range"`
	DestPortFrom int    `json:"dest_port_from,omitempty"`
	Action       string `json:"action"`
	Position     int    `json:"position"`
	DestPortTo   string `json:"dest_port_to"`
	Editable     bool   `json:"editable"`
	ID           string `json:"id"`
}

type Server struct {
	// Arch is the architecture target of the server
	Arch string `json:"arch,omitempty"`

	// Identifier is a unique identifier for the server
	Identifier string `json:"id,omitempty"`

	// Name is the user-defined name of the server
	Name string `json:"name,omitempty"`

	// CreationDate is the creation date of the server
	CreationDate string `json:"creation_date,omitempty"`

	// ModificationDate is the date of the last modification of the server
	ModificationDate string `json:"modification_date,omitempty"`

	// Image is the image used by the server
	Image Image `json:"image,omitempty"`

	// DynamicIPRequired is a flag that defines a server with a dynamic ip address attached
	DynamicIPRequired *bool `json:"dynamic_ip_required,omitempty"`

	// PublicIP is the public IP address bound to the server
	PublicAddress IPAddress `json:"public_ip,omitempty"`

	// State is the current status of the server
	State string `json:"state,omitempty"`

	// StateDetail is the detailed status of the server
	StateDetail string `json:"state_detail,omitempty"`

	// PrivateIP represents the private IPV4 attached to the server (changes on each boot)
	PrivateIP string `json:"private_ip,omitempty"`

	// Bootscript is the unique identifier of the selected bootscript
	Bootscript *Bootscript `json:"bootscript,omitempty"`

	// BootType defines the type of boot. Can be local or bootscript
	BootType string `json:"boot_type,omitempty"`

	// Hostname represents the ServerName in a format compatible with unix's hostname
	Hostname string `json:"hostname,omitempty"`

	// Tags represents user-defined tags
	Tags []string `json:"tags,omitempty"`

	// Volumes are the attached volumes
	Volumes map[string]Volume `json:"volumes,omitempty"`

	// SecurityGroup is the selected security group object
	SecurityGroup SecurityGroupRef `json:"security_group,omitempty"`

	// Organization is the owner of the server
	Organization string `json:"organization,omitempty"`

	// CommercialType is the commercial type of the server (i.e: C1, C2[SML], VC1S)
	CommercialType string `json:"commercial_type,omitempty"`

	// Location of the server
	Location struct {
		Platform   string `json:"platform_id,omitempty"`
		Chassis    string `json:"chassis_id,omitempty"`
		Cluster    string `json:"cluster_id,omitempty"`
		Hypervisor string `json:"hypervisor_id,omitempty"`
		Blade      string `json:"blade_id,omitempty"`
		Node       string `json:"node_id,omitempty"`
		ZoneID     string `json:"zone_id,omitempty"`
	} `json:"location,omitempty"`

	IPV6 *IPV6 `json:"ipv6,omitempty"`

	EnableIPV6 bool `json:"enable_ipv6,omitempty"`

	// This fields are not returned by the API, we generate it
	DNSPublic  string `json:"dns_public,omitempty"`
	DNSPrivate string `json:"dns_private,omitempty"`
}

type ServerAction struct {
	// Action is the name of the action to trigger
	Action string `json:"action,omitempty"`
}

type ServerAvailabilities map[string]ServerAvailability

type ServerAvailability struct {
	Availability InstanceTypeAvailability `json:"availability"`
}

type ServerDefinition struct {
	// Name is the user-defined name of the server
	Name string `json:"name"`

	// Image is the image used by the server
	Image *string `json:"image,omitempty"`

	// Volumes are the attached volumes
	Volumes map[string]string `json:"volumes,omitempty"`

	// DynamicIPRequired is a flag that defines a server with a dynamic ip address attached
	DynamicIPRequired *bool `json:"dynamic_ip_required,omitempty"`

	// Bootscript is the bootscript used by the server
	Bootscript *string `json:"bootscript"`

	// Tags are the metadata tags attached to the server
	Tags []string `json:"tags,omitempty"`

	// Organization is the owner of the server
	Organization string `json:"organization"`

	// CommercialType is the commercial type of the server (i.e: C1, C2[SML], VC1S)
	CommercialType string `json:"commercial_type"`

	// BootType defines the type of boot. Can be local or bootscript
	BootType string `json:"boot_type,omitempty"`

	PublicIP string `json:"public_ip,omitempty"`

	EnableIPV6 bool `json:"enable_ipv6,omitempty"`

	SecurityGroup string `json:"security_group,omitempty"`
}

type ServerPatchDefinition struct {
	Arch              *string            `json:"arch,omitempty"`
	Name              *string            `json:"name,omitempty"`
	CreationDate      *string            `json:"creation_date,omitempty"`
	ModificationDate  *string            `json:"modification_date,omitempty"`
	Image             *Image             `json:"image,omitempty"`
	DynamicIPRequired *bool              `json:"dynamic_ip_required,omitempty"`
	PublicAddress     *IPAddress         `json:"public_ip,omitempty"`
	State             *string            `json:"state,omitempty"`
	StateDetail       *string            `json:"state_detail,omitempty"`
	PrivateIP         *string            `json:"private_ip,omitempty"`
	Bootscript        *string            `json:"bootscript,omitempty"`
	Hostname          *string            `json:"hostname,omitempty"`
	Volumes           *map[string]Volume `json:"volumes,omitempty"`
	SecurityGroup     *SecurityGroupRef  `json:"security_group,omitempty"`
	Organization      *string            `json:"organization,omitempty"`
	Tags              *[]string          `json:"tags,omitempty"`
	IPV6              *IPV6              `json:"ipv6,omitempty"`
	EnableIPV6        *bool              `json:"enable_ipv6,omitempty"`
}

type ServerRef struct {
	Identifier string `json:"id,omitempty"`
	Name       string `json:"name,omitempty"`
}

type Servers struct {
	// Servers holds  servers of the response
	Servers []Server `json:"servers,omitempty"`
}

type Snapshot struct {
	// Identifier is a unique identifier for the snapshot
	Identifier string `json:"id,omitempty"`

	// Name is a user-defined name for the snapshot
	Name string `json:"name,omitempty"`

	// CreationDate is the creation date of the snapshot
	CreationDate string `json:"creation_date,omitempty"`

	// ModificationDate is the date of the last modification of the snapshot
	ModificationDate string `json:"modification_date,omitempty"`

	// Size is the allocated size of the volume
	Size uint64 `json:"size,omitempty"`

	// Organization is the owner of the snapshot
	Organization string `json:"organization"`

	// State is the current state of the snapshot
	State string `json:"state"`

	// VolumeType is the kind of volume behind the snapshot
	VolumeType string `json:"volume_type"`

	// BaseVolume is the volume from which the snapshot inherits
	BaseVolume Volume `json:"base_volume,omitempty"`
}

type SnapshotDefinition struct {
	VolumeIDentifier string `json:"volume_id"`
	Name             string `json:"name,omitempty"`
	Organization     string `json:"organization"`
}

type Snapshots struct {
	// Snapshots holds  snapshots of the response
	Snapshots []Snapshot `json:"snapshots,omitempty"`
}

type SortServers []Server

type Task struct {
	// Identifier is a unique identifier for the task
	Identifier string `json:"id,omitempty"`

	// StartDate is the start date of the task
	StartDate string `json:"started_at,omitempty"`

	// TerminationDate is the termination date of the task
	TerminationDate string `json:"terminated_at,omitempty"`

	HrefFrom string `json:"href_from,omitempty"`

	Description string `json:"description,omitempty"`

	Status string `json:"status,omitempty"`

	Progress int `json:"progress,omitempty"`
}

type Tasks struct {
	// Tasks holds  tasks of the response
	Tasks []Task `json:"tasks,omitempty"`
}

type Token struct {
	UserID             string `json:"user_id"`
	Description        string `json:"description,omitempty"`
	Roles              Role   `json:"roles"`
	Expires            string `json:"expires"`
	InheritsUsersPerms bool   `json:"inherits_user_perms"`
	ID                 string `json:"id"`
}

type UpdateIPRequest struct {
	ID      string
	Reverse string
}

type UpdateSecurityGroup struct {
	Organization        string `json:"organization"`
	Name                string `json:"name"`
	Description         string `json:"description"`
	OrganizationDefault bool   `json:"organization_default"`
}

type UpdateSecurityGroupRule struct {
	Action       string `json:"action"`
	Direction    string `json:"direction"`
	IPRange      string `json:"ip_range"`
	Protocol     string `json:"protocol"`
	Position     int    `json:"position"`
	DestPortFrom int    `json:"dest_port_from,omitempty"`
}

type UpdateTokenRequest struct {
	Description string `json:"description,omitempty"`
	Expires     bool   `json:"expires"`
	ID          string `json:"-"`
}

type User struct {
	Email         string          `json:"email"`
	Firstname     string          `json:"firstname"`
	Fullname      string          `json:"fullname"`
	ID            string          `json:"id"`
	Lastname      string          `json:"lastname"`
	Organizations []Organization  `json:"organizations"`
	Roles         []Role          `json:"roles"`
	SSHPublicKeys []KeyDefinition `json:"ssh_public_keys"`
}

type UserPatchSSHKeyDefinition struct {
	SSHPublicKeys []KeyDefinition `json:"ssh_public_keys"`
}

type Userdata []byte

type Userdatas struct {
	UserData []string `json:"user_data"`
}

type UsersDefinition struct {
	User User `json:"user"`
}

type Volume struct {
	// Identifier is a unique identifier for the volume
	Identifier string `json:"id,omitempty"`

	// Size is the allocated size of the volume
	Size uint64 `json:"size,omitempty"`

	// CreationDate is the creation date of the volume
	CreationDate string `json:"creation_date,omitempty"`

	// ModificationDate is the date of the last modification of the volume
	ModificationDate string `json:"modification_date,omitempty"`

	// Organization is the organization owning the volume
	Organization string `json:"organization,omitempty"`

	// Name is the name of the volume
	Name string `json:"name,omitempty"`

	// Server is the server using this image
	Server *struct {
		Identifier string `json:"id,omitempty"`
		Name       string `json:"name,omitempty"`
	} `json:"server,omitempty"`

	// VolumeType is a  identifier for the kind of volume (default: l_ssd)
	VolumeType string `json:"volume_type,omitempty"`

	// ExportURI represents the url used by initrd/scripts to attach the volume
	ExportURI string `json:"export_uri,omitempty"`
}

type VolumeDefinition struct {
	// Name is the user-defined name of the volume
	Name string `json:"name"`

	// Image is the image used by the volume
	Size uint64 `json:"size"`

	// Bootscript is the bootscript used by the volume
	Type string `json:"volume_type"`

	// Organization is the owner of the volume
	Organization string `json:"organization"`
}

type VolumePutDefinition struct {
	Identifier       *string `json:"id,omitempty"`
	Size             *uint64 `json:"size,omitempty"`
	CreationDate     *string `json:"creation_date,omitempty"`
	ModificationDate *string `json:"modification_date,omitempty"`
	Organization     *string `json:"organization,omitempty"`
	Name             *string `json:"name,omitempty"`
	Server           struct {
		Identifier *string `json:"id,omitempty"`
		Name       *string `json:"name,omitempty"`
	} `json:"server,omitempty"`
	VolumeType *string `json:"volume_type,omitempty"`
	ExportURI  *string `json:"export_uri,omitempty"`
}