instance

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

type AddSecurityGroupRulesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupID: ID of the security group to add rules to.
	SecurityGroupID string `json:"security_group_id"`

	// SecurityGroupRules: list of rules to add.
	SecurityGroupRules []*SecurityGroupRuleConfig `json:"security_group_rules"`
}

type AddSecurityGroupRulesResponse struct {
	// SecurityGroup: updated security group.
	SecurityGroup *SecurityGroup `json:"security_group"`

	// AddedRules: list of rules that were added.
	AddedRules []*SecurityGroupRule `json:"added_rules"`
}

type AttachServerFileSystemRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to attach the filesystem to.
	ServerID string `json:"-"`

	// FilesystemID: ID of the filesystem to attach.
	FilesystemID string `json:"filesystem_id"`
}

type AttachServerIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to attach the IP to.
	ServerID string `json:"-"`

	// IPID: ID of the IP to attach.
	IPID string `json:"ip_id"`

	// Default: whether the IP should be the default IP.
	Default bool `json:"default"`

	// MoveAllowed: whether moving the IP is allowed.
	MoveAllowed bool `json:"move_allowed"`
}

type AttachServerPrivateNetworkInterfaceRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to attach the private network interface to.
	ServerID string `json:"-"`

	// PrivateNetworkInterfaceID: ID of the private network interface to attach.
	PrivateNetworkInterfaceID string `json:"private_network_interface_id"`
}

type AttachServerVolumeRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to attach the volume to.
	ServerID string `json:"-"`

	// VolumeID: ID of the volume to attach.
	VolumeID string `json:"volume_id"`

	// VolumeType: type of the volume.
	// Default value: unknown_volume_type
	VolumeType ServerVolumeVolumeType `json:"volume_type"`

	// BootVolume: whether the volume should be used as the boot volume.
	BootVolume bool `json:"boot_volume"`
}

type CheckTemplateRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template to check.
	TemplateID string `json:"-"`
}

type CreatePlacementGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ProjectID: project ID of the placement group.
	ProjectID string `json:"project_id"`

	// Name: name of the placement group.
	Name string `json:"name"`

	// PolicyType: policy type of the placement group.
	// Default value: unknown_policy_type
	PolicyType PlacementGroupPolicyType `json:"policy_type"`

	// Tags: tags of the placement group.
	Tags []string `json:"tags"`
}

type CreatePrivateNetworkInterfaceRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PrivateNetworkID: ID of the Private Network to attach to.
	PrivateNetworkID string `json:"private_network_id"`

	// ProjectID: project ID for the private network interface.
	ProjectID string `json:"project_id"`

	// ServerID: ID of the Instance to attach the interface to.
	ServerID *string `json:"server_id,omitempty"`

	// IPIDs: list of IP IDs to attach to the interface.
	IPIDs []string `json:"ip_ids"`

	// Tags: tags to assign to the private network interface.
	Tags []string `json:"tags"`
}

type CreateSecurityGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// Name: name of the security group.
	Name string `json:"name"`

	// Description: description of the security group.
	Description string `json:"description"`

	// DisableDefaultRules: whether to disable default rules.
	DisableDefaultRules bool `json:"disable_default_rules"`

	// ProjectID: project ID the security group belongs to.
	ProjectID string `json:"project_id"`

	// Tags: tags for the security group.
	Tags []string `json:"tags"`

	// ProjectDefault: whether this should be the default security group for the project.
	ProjectDefault bool `json:"project_default"`

	// InboundDefaultAction: default action for inbound rules.
	// Default value: unknown_action
	InboundDefaultAction SecurityGroupAction `json:"inbound_default_action"`

	// OutboundDefaultAction: default action for outbound rules.
	// Default value: unknown_action
	OutboundDefaultAction SecurityGroupAction `json:"outbound_default_action"`

	// Stateless: whether the security group should be stateless.
	Stateless bool `json:"stateless"`
}

type CreateServerFromTemplateRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template to use.
	TemplateID string `json:"-"`

	// Name: name of the new server.
	Name string `json:"name"`
}

type CreateServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ProjectID: project ID for the server.
	ProjectID string `json:"project_id"`

	// Name: name of the server.
	Name string `json:"name"`

	// Tags: tags to associate with the server.
	Tags []string `json:"tags"`

	// ServerType: type of the server.
	ServerType string `json:"server_type"`

	// PlacementGroupID: ID of the placement group the server belongs to.
	PlacementGroupID *string `json:"placement_group_id,omitempty"`

	// Volumes: volumes to attach to the server.
	Volumes []*CreateServerRequestServerVolume `json:"volumes"`

	// WindowsRdpSSHKeyID: iAM ID of the SSH key used to encrypt the Windows `Administrator` password for RDP use.
	WindowsRdpSSHKeyID *string `json:"windows_rdp_ssh_key_id,omitempty"`

	// PublicNetworkInterface: public network interface configuration.
	PublicNetworkInterface *CreateServerRequestPublicNetworkInterface `json:"public_network_interface,omitempty"`
}

type CreateServerRequestBookIP struct {
	// Type: type of IP to book.
	// Default value: unknown_ip_type
	Type CreateServerRequestBookIPIPType `json:"type"`

	// Tags: tags to associate with the IP.
	Tags []string `json:"tags"`
}

type CreateServerRequestBookIPIPType string

type CreateServerRequestCreateVolume struct {
	// Name: name of the volume.
	Name string `json:"name"`

	// Tags: tags to associate with the volume.
	Tags []string `json:"tags"`

	// Size: size of the volume.
	Size *scw.Size `json:"size"`

	// BaseSnapshotID: ID of the base snapshot for the volume.
	// Precisely one of BaseSnapshotID, ImageLabel must be set.
	BaseSnapshotID *string `json:"base_snapshot_id,omitempty"`

	// ImageLabel: label of the image to use for the volume.
	// Precisely one of BaseSnapshotID, ImageLabel must be set.
	ImageLabel *string `json:"image_label,omitempty"`

	// PerfIops: performance IOPS for the volume.
	PerfIops *uint32 `json:"perf_iops"`
}

type CreateServerRequestPublicNetworkInterface struct {
	// SecurityGroupID: ID of the security group for the interface.
	SecurityGroupID *string `json:"security_group_id"`

	// IPs: list of IPs to attach to the interface.
	IPs []*CreateServerRequestServerIP `json:"ips"`
}

type CreateServerRequestServerIP struct {
	// IpamIPID: ID of the IPAM IP to attach.
	// Precisely one of IpamIPID, NewIP must be set.
	IpamIPID *string `json:"ipam_ip_id,omitempty"`

	// NewIP: configuration for a new IP to book.
	// Precisely one of IpamIPID, NewIP must be set.
	NewIP *CreateServerRequestBookIP `json:"new_ip,omitempty"`
}

type CreateServerRequestServerVolume struct {
	// VolumeType: type of the volume.
	// Default value: unknown_volume_type
	VolumeType CreateServerRequestServerVolumeVolumeType `json:"volume_type"`

	// VolumeID: ID of the volume to attach.
	// Precisely one of VolumeID, NewVolume must be set.
	VolumeID *string `json:"volume_id,omitempty"`

	// NewVolume: configuration for a new volume to create.
	// Precisely one of VolumeID, NewVolume must be set.
	NewVolume *CreateServerRequestCreateVolume `json:"new_volume,omitempty"`
}

type CreateServerRequestServerVolumeVolumeType string

type CreateTemplateRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ProjectID: project ID for the template.
	ProjectID string `json:"project_id"`

	// Name: name of the template.
	Name string `json:"name"`

	// Tags: tags to associate with the template.
	Tags []string `json:"tags"`

	// ServerTags: tags to associate with servers created from the template.
	ServerTags []string `json:"server_tags"`

	// ServerType: commercial type of the server defined by the template.
	ServerType string `json:"server_type"`

	// SecurityGroupID: security group ID for the template.
	SecurityGroupID *string `json:"security_group_id,omitempty"`

	// PlacementGroupID: placement group ID for the template.
	PlacementGroupID *string `json:"placement_group_id,omitempty"`

	// Volumes: list of volume templates to define volumes for servers.
	Volumes []*CreateTemplateRequestVolumeTemplate `json:"volumes"`

	// PrivateNetworks: list of private networks to associate with the template.
	PrivateNetworks []*CreateTemplateRequestPrivateNetworkTemplate `json:"private_networks"`

	// FilesystemIDs: list of filesystem IDs to associate with the template.
	FilesystemIDs []string `json:"filesystem_ids"`

	// PublicIPV4Count: number of IPv4 public IPs to attach to servers created from this template.
	PublicIPV4Count uint32 `json:"public_ip_v4_count"`

	// PublicIPV6Count: number of IPv6 public IPs to attach to servers created from this template.
	PublicIPV6Count uint32 `json:"public_ip_v6_count"`

	// WindowsRdpSSHKeyID: iAM ID of the SSH key used to encrypt the Windows `Administrator` password for RDP use.
	WindowsRdpSSHKeyID *string `json:"windows_rdp_ssh_key_id,omitempty"`
}

type CreateTemplateRequestPrivateNetworkTemplate struct {
	// PrivateNetworkID: ID of the private network.
	PrivateNetworkID string `json:"private_network_id"`
}

type CreateTemplateRequestVolumeTemplate struct {
	// VolumeType: type of the volume.
	// Default value: unknown_volume_type
	VolumeType CreateServerRequestServerVolumeVolumeType `json:"volume_type"`

	// Name: name of the volume.
	Name string `json:"name"`

	// Tags: tags associated with the volume.
	Tags []string `json:"tags"`

	// Size: size of the volume in bytes.
	Size *scw.Size `json:"size"`

	// BaseSnapshotID: ID of the base snapshot for the volume.
	// Precisely one of BaseSnapshotID, ImageLabel must be set.
	BaseSnapshotID *string `json:"base_snapshot_id,omitempty"`

	// ImageLabel: label of the image used as base for the volume.
	// Precisely one of BaseSnapshotID, ImageLabel must be set.
	ImageLabel *string `json:"image_label,omitempty"`

	// PerfIops: performance IOPS for the volume.
	PerfIops *uint32 `json:"perf_iops"`
}

type CreateVolumeRequestVolumeType string

type DeletePlacementGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PlacementGroupID: UUID of the placement group you want to delete.
	PlacementGroupID string `json:"-"`
}

type DeletePrivateNetworkInterfaceRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PrivateNetworkInterfaceID: ID of the private network interface to delete.
	PrivateNetworkInterfaceID string `json:"-"`
}

type DeleteSecurityGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupID: ID of the security group to delete.
	SecurityGroupID string `json:"-"`
}

type DeleteSecurityGroupRulesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupRuleIDs: list of rule IDs to delete.
	SecurityGroupRuleIDs []string `json:"security_group_rule_ids"`
}

type DeleteServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to delete.
	ServerID string `json:"-"`

	// DeleteAllIPs: whether to delete all IPs attached to the server.
	// Precisely one of DeleteAllIPs, DeleteIPIDs must be set.
	DeleteAllIPs *bool `json:"delete_all_ips,omitempty"`

	// DeleteIPIDs: list of IP IDs to delete.
	// Precisely one of DeleteAllIPs, DeleteIPIDs must be set.
	DeleteIPIDs *[]string `json:"delete_ip_ids,omitempty"`

	// DeleteAllVolumes: whether to delete all volumes attached to the server.
	// Precisely one of DeleteAllVolumes, DeleteVolumeIDs must be set.
	DeleteAllVolumes *bool `json:"delete_all_volumes,omitempty"`

	// DeleteVolumeIDs: list of volume IDs to delete.
	// Precisely one of DeleteAllVolumes, DeleteVolumeIDs must be set.
	DeleteVolumeIDs *[]string `json:"delete_volume_ids,omitempty"`

	// KeepAllPrivateNics: whether to keep all private network interfaces.
	// Precisely one of KeepAllPrivateNics, DeletePrivateNicIDs must be set.
	KeepAllPrivateNics *bool `json:"keep_all_private_nics,omitempty"`

	// DeletePrivateNicIDs: list of private network interface IDs to delete.
	// Precisely one of KeepAllPrivateNics, DeletePrivateNicIDs must be set.
	DeletePrivateNicIDs *[]string `json:"delete_private_nic_ids,omitempty"`
}

type DeleteTemplateRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template to delete.
	TemplateID string `json:"-"`
}

type DeleteTemplateUserDataRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template.
	TemplateID string `json:"-"`

	// Key: key of the user data to delete.
	Key string `json:"-"`
}

type DeleteUserDataRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: the ID of the server.
	ServerID string `json:"-"`

	// Key: the key of the user data to delete.
	Key string `json:"-"`
}

type DetachServerFileSystemRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to detach the filesystem from.
	ServerID string `json:"-"`

	// FilesystemID: ID of the filesystem to detach.
	FilesystemID string `json:"filesystem_id"`
}

type DetachServerIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to detach the IP from.
	ServerID string `json:"-"`

	// IPID: ID of the IP to detach.
	IPID string `json:"ip_id"`
}

type DetachServerPrivateNetworkInterfaceRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to detach the private network interface from.
	ServerID string `json:"-"`

	// PrivateNetworkInterfaceID: ID of the private network interface to detach.
	PrivateNetworkInterfaceID string `json:"private_network_interface_id"`
}

type DetachServerVolumeRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to detach the volume from.
	ServerID string `json:"-"`

	// VolumeID: ID of the volume to detach.
	VolumeID string `json:"volume_id"`
}

type GetPlacementGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PlacementGroupID: UUID of the placement group you want to get.
	PlacementGroupID string `json:"-"`
}

type GetPrivateNetworkInterfaceRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PrivateNetworkInterfaceID: ID of the private network interface to retrieve.
	PrivateNetworkInterfaceID string `json:"-"`
}

type GetResourceCountsRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// OrganizationID: organization ID to filter resource counts.
	// Precisely one of OrganizationID, ProjectID must be set.
	OrganizationID *string `json:"organization_id,omitempty"`

	// ProjectID: project ID to filter resource counts.
	// Precisely one of OrganizationID, ProjectID must be set.
	ProjectID *string `json:"project_id,omitempty"`
}

type GetSecurityGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupID: ID of the security group to retrieve.
	SecurityGroupID string `json:"-"`
}

type GetServerCloudInitRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: the ID of the server.
	ServerID string `json:"-"`
}

type GetServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to retrieve.
	ServerID string `json:"-"`
}

type GetTemplateCloudInitRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template.
	TemplateID string `json:"-"`
}

type GetTemplateRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template to retrieve.
	TemplateID string `json:"-"`
}

type GetTemplateUserDataRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template.
	TemplateID string `json:"-"`

	// Key: key of the user data to retrieve.
	Key string `json:"-"`
}

type GetUserDataRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: the ID of the server.
	ServerID string `json:"-"`

	// Key: the key of the user data to retrieve.
	Key string `json:"-"`
}

type ListPlacementGroupsRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: the initial pagination token to start from.
	PageToken *string `json:"-"`

	// PageSize: the maximum number of placement groups to return.
	PageSize *uint32 `json:"-"`

	// OrderBy: the field by which to order the result list.
	// Default value: created_at_desc
	OrderBy ListPlacementGroupsRequestOrderBy `json:"-"`

	// ProjectID: list only placement groups of this Project ID.
	ProjectID string `json:"-"`

	// PlacementGroupIDs: list only placement groups with these IDs.
	PlacementGroupIDs []string `json:"-"`

	// Name: filter placement groups by name.
	Name *string `json:"-"`

	// Tags: list placement groups with these exact tags.
	Tags []string `json:"-"`
}

type ListPlacementGroupsRequestOrderBy string

type ListPlacementGroupsResponse struct {
	// PlacementGroups: list of placement groups.
	PlacementGroups []*PlacementGroup `json:"placement_groups"`

	// NextPageToken: the pagination token, use it to get the next page of results.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of placement groups.
	TotalCount uint64 `json:"total_count"`
}

type ListPrivateNetworkInterfacesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: field to order results by.
	// Default value: created_at_desc
	OrderBy ListPrivateNetworkInterfacesRequestOrderBy `json:"-"`

	// ProjectID: filter by Project ID.
	ProjectID string `json:"-"`

	// ServerIDs: filter by server IDs.
	ServerIDs []string `json:"-"`

	// PrivateNetworkIDs: filter by Private Network IDs.
	PrivateNetworkIDs []string `json:"-"`

	// Tags: filter by tags.
	Tags []string `json:"-"`
}

type ListPrivateNetworkInterfacesRequestOrderBy string

type ListPrivateNetworkInterfacesResponse struct {
	// PrivateNetworkInterfaces: list of private network interfaces.
	PrivateNetworkInterfaces []*PrivateNetworkInterfaceSummary `json:"private_network_interfaces"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListSecurityGroupsRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: field and direction to sort by.
	// Default value: created_at_desc
	OrderBy ListSecurityGroupsRequestOrderBy `json:"-"`

	// ProjectID: filter by Project ID.
	ProjectID string `json:"-"`

	// Name: filter by name.
	Name *string `json:"-"`

	// Tags: filter by tags.
	Tags []string `json:"-"`

	// SecurityGroupIDs: filter by specific security group IDs.
	SecurityGroupIDs []string `json:"-"`
}

type ListSecurityGroupsRequestOrderBy string

type ListSecurityGroupsResponse struct {
	// SecurityGroups: list of security groups.
	SecurityGroups []*SecurityGroupSummary `json:"security_groups"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListServerTypesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of server types to return per page.
	PageSize *uint32 `json:"-"`
}

type ListServerTypesResponse struct {
	// ServerTypes: list of server types.
	ServerTypes []*ServerType `json:"server_types"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of server types.
	TotalCount uint64 `json:"total_count"`
}

type ListServersRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of servers to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: order of the returned servers.
	// Default value: created_at_desc
	OrderBy ListServersRequestOrderBy `json:"-"`

	// ProjectID: project ID to filter servers.
	ProjectID string `json:"-"`

	// ServerIDs: list of server IDs to filter.
	ServerIDs []string `json:"-"`

	// Name: name to filter servers.
	Name *string `json:"-"`

	// ServerType: server type to filter.
	ServerType *string `json:"-"`

	// Tags: tags to filter servers.
	Tags []string `json:"-"`

	// SecurityGroupIDs: security group IDs to filter servers.
	SecurityGroupIDs []string `json:"-"`

	// PlacementGroupIDs: placement group IDs to filter servers.
	PlacementGroupIDs []string `json:"-"`

	// PrivateNetworkIDs: private Network IDs to filter servers.
	PrivateNetworkIDs []string `json:"-"`

	// MacAddresses: mAC addresses to filter servers.
	MacAddresses []string `json:"-"`
}

type ListServersRequestOrderBy string

type ListServersResponse struct {
	// Servers: list of servers.
	Servers []*ServerSummary `json:"servers"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of servers.
	TotalCount uint64 `json:"total_count"`
}

type ListSnapshotsRequestOrderBy string

type ListSnapshotsResponse struct {
	// Snapshots: list of snapshots.
	Snapshots []*Snapshot `json:"snapshots"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListTemplateUserDataKeysRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template.
	TemplateID string `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`
}

type ListTemplateUserDataKeysResponse struct {
	// Keys: list of user data keys associated with the template.
	Keys []string `json:"keys"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListTemplatesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: field to sort results by.
	// Default value: created_at_desc
	OrderBy ListTemplatesRequestOrderBy `json:"-"`

	// ProjectID: filter by Project ID.
	ProjectID string `json:"-"`

	// TemplateIDs: filter by specific template IDs.
	TemplateIDs []string `json:"-"`

	// Name: filter by template name.
	Name *string `json:"-"`

	// Tags: filter by tags.
	Tags []string `json:"-"`

	// ServerTags: filter by server tags.
	ServerTags []string `json:"-"`

	// SecurityGroupIDs: filter by security group IDs.
	SecurityGroupIDs []string `json:"-"`

	// PlacementGroupIDs: filter by placement group IDs.
	PlacementGroupIDs []string `json:"-"`
}

type ListTemplatesRequestOrderBy string

type ListTemplatesResponse struct {
	// Templates: list of template summaries.
	Templates []*TemplateSummary `json:"templates"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListUserDataKeysRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: the ID of the server.
	ServerID string `json:"-"`

	// PageToken: page token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`
}

type ListUserDataKeysResponse struct {
	// Keys: list of user data keys.
	Keys []string `json:"keys"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListVolumeTypesResponse struct {
	// VolumeTypes: list of volume types.
	VolumeTypes []*VolumeType `json:"volume_types"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type ListVolumesRequestOrderBy string

type ListVolumesResponse struct {
	// Volumes: list of volumes.
	Volumes []*Volume `json:"volumes"`

	// NextPageToken: token for the next page.
	NextPageToken *string `json:"next_page_token"`

	// TotalCount: total number of items.
	TotalCount uint64 `json:"total_count"`
}

type PauseServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to pause.
	ServerID string `json:"-"`
}

type PlacementGroup struct {
	// ID: placement group unique ID.
	ID string `json:"id"`

	// ProjectID: placement group Project ID.
	ProjectID string `json:"project_id"`

	// Name: placement group name.
	Name string `json:"name"`

	// PolicyType: select the behavior of the placement group, either low_latency (group) or max_availability (spread).
	// Default value: unknown_policy_type
	PolicyType PlacementGroupPolicyType `json:"policy_type"`

	// Tags: placement group tags.
	Tags []string `json:"tags"`

	// CreatedAt: placement group creation date.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: placement group modification date.
	UpdatedAt *time.Time `json:"updated_at"`

	// Zone: zone in which the placement group is located.
	Zone scw.Zone `json:"zone"`
}

type PlacementGroupPolicyType string

type PrivateNetworkInterface struct {
	// ID: unique ID of the private network interface.
	ID string `json:"id"`

	// PrivateNetworkID: ID of the Private Network this interface is attached to.
	PrivateNetworkID string `json:"private_network_id"`

	// ProjectID: project ID the private network interface belongs to.
	ProjectID string `json:"project_id"`

	// ServerID: ID of the Instance this interface is attached to.
	ServerID string `json:"server_id"`

	// MacAddress: mAC address of the private network interface.
	MacAddress string `json:"mac_address"`

	// Status: current status of the private network interface.
	// Default value: unknown_status
	Status PrivateNetworkInterfaceStatus `json:"status"`

	// IPIDs: list of IP IDs attached to this interface.
	IPIDs []string `json:"ip_ids"`

	// Tags: tags associated with the private network interface.
	Tags []string `json:"tags"`

	// CreatedAt: creation timestamp of the private network interface.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the private network interface.
	UpdatedAt *time.Time `json:"updated_at"`
}

type PrivateNetworkInterfaceStatus string

type PrivateNetworkInterfaceSummary struct {
	// ID: unique ID of the private network interface.
	ID string `json:"id"`

	// PrivateNetworkID: ID of the Private Network this interface is attached to.
	PrivateNetworkID string `json:"private_network_id"`

	// ProjectID: project ID the private network interface belongs to.
	ProjectID string `json:"project_id"`

	// ServerID: ID of the Instance this interface is attached to.
	ServerID string `json:"server_id"`

	// MacAddress: mAC address of the private network interface.
	MacAddress string `json:"mac_address"`

	// Status: current status of the private network interface.
	// Default value: unknown_status
	Status PrivateNetworkInterfaceStatus `json:"status"`

	// IPIDs: list of IP IDs attached to this interface.
	IPIDs []string `json:"ip_ids"`

	// Tags: tags associated with the private network interface.
	Tags []string `json:"tags"`

	// CreatedAt: creation timestamp of the private network interface.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the private network interface.
	UpdatedAt *time.Time `json:"updated_at"`
}

type RebootServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to reboot.
	ServerID string `json:"-"`
}

type ResourceCounts struct {
	// Servers: number of servers.
	Servers uint32 `json:"servers"`

	// GpuServers: number of GPU servers.
	GpuServers uint32 `json:"gpu_servers"`

	// ServersByType: map of server types with their counts.
	ServersByType map[string]uint32 `json:"servers_by_type"`

	// SecurityGroups: number of security groups.
	SecurityGroups uint32 `json:"security_groups"`

	// PlacementGroups: number of placement groups.
	PlacementGroups uint32 `json:"placement_groups"`

	// Snapshots: number of snapshots.
	Snapshots uint32 `json:"snapshots"`

	// Volumes: number of volumes.
	Volumes uint32 `json:"volumes"`

	// VolumesLSSD: number of local SSD volumes.
	VolumesLSSD uint32 `json:"volumes_l_ssd"`

	// VolumesLSSDTotalSize: total size of local SSD volumes in bytes.
	VolumesLSSDTotalSize uint64 `json:"volumes_l_ssd_total_size"`

	// VolumesScratch: number of scratch volumes.
	VolumesScratch uint32 `json:"volumes_scratch"`

	// PrivateNetworkInterfaces: number of private network interfaces.
	PrivateNetworkInterfaces uint32 `json:"private_network_interfaces"`
}

type SecurityGroup struct {
	// ID: unique ID of the security group.
	ID string `json:"id"`

	// Name: name of the security group.
	Name string `json:"name"`

	// Description: description of the security group.
	Description string `json:"description"`

	// ProjectID: project ID the security group belongs to.
	ProjectID string `json:"project_id"`

	// Tags: tags associated with the security group.
	Tags []string `json:"tags"`

	// DisableDefaultRules: true if default rules are disabled.
	DisableDefaultRules bool `json:"disable_default_rules"`

	// ProjectDefault: true if this is the default security group for the project.
	ProjectDefault bool `json:"project_default"`

	// InboundDefaultAction: default action for inbound rules.
	// Default value: unknown_action
	InboundDefaultAction SecurityGroupAction `json:"inbound_default_action"`

	// OutboundDefaultAction: default action for outbound rules.
	// Default value: unknown_action
	OutboundDefaultAction SecurityGroupAction `json:"outbound_default_action"`

	// Stateless: true if the security group is stateless.
	Stateless bool `json:"stateless"`

	// CreatedAt: creation timestamp of the security group.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the security group.
	UpdatedAt *time.Time `json:"updated_at"`

	// DefaultRules: list of default rules applied to the security group.
	DefaultRules []*SecurityGroupRule `json:"default_rules"`

	// Rules: list of custom rules applied to the security group.
	Rules []*SecurityGroupRule `json:"rules"`

	// Zone: zone in which the security group is located.
	Zone scw.Zone `json:"zone"`
}

type SecurityGroupAction string

type SecurityGroupRule struct {
	// ID: unique ID of the rule.
	ID string `json:"id"`

	// Protocol: protocol this rule applies to.
	// Default value: unknown_protocol
	Protocol SecurityGroupRuleProtocol `json:"protocol"`

	// Direction: direction of traffic this rule applies to.
	// Default value: unknown_direction
	Direction SecurityGroupRuleDirection `json:"direction"`

	// Action: action to take when the rule matches.
	// Default value: unknown_action
	Action SecurityGroupRuleAction `json:"action"`

	// SourceIPRange: source IP range for the rule.
	SourceIPRange scw.IPNet `json:"source_ip_range"`

	// DestinationIPRange: destination IP range for the rule.
	DestinationIPRange scw.IPNet `json:"destination_ip_range"`

	// SourcePorts: source port range for the rule.
	SourcePorts *SecurityGroupRulePortRange `json:"source_ports"`

	// DestinationPorts: destination port range for the rule.
	DestinationPorts *SecurityGroupRulePortRange `json:"destination_ports"`

	// Position: position of the rule in the list.
	Position uint32 `json:"position"`
}

type SecurityGroupRuleAction string

type SecurityGroupRuleConfig struct {
	// Protocol: protocol for the rule.
	// Default value: unknown_protocol
	Protocol SecurityGroupRuleProtocol `json:"protocol"`

	// Direction: direction of traffic for the rule.
	// Default value: unknown_direction
	Direction SecurityGroupRuleDirection `json:"direction"`

	// Action: action to take when the rule matches.
	// Default value: unknown_action
	Action SecurityGroupRuleAction `json:"action"`

	// SourceIPRange: source IP range for the rule.
	SourceIPRange scw.IPNet `json:"source_ip_range"`

	// DestinationIPRange: destination IP range for the rule.
	DestinationIPRange scw.IPNet `json:"destination_ip_range"`

	// SourcePorts: source port range for the rule.
	SourcePorts *SecurityGroupRulePortRange `json:"source_ports"`

	// DestinationPorts: destination port range for the rule.
	DestinationPorts *SecurityGroupRulePortRange `json:"destination_ports"`

	// Position: position of the rule in the list.
	Position int32 `json:"position"`
}

type SecurityGroupRuleDirection string

type SecurityGroupRulePortRange struct {
	// Start: start of the port range.
	Start uint32 `json:"start"`

	// End: end of the port range.
	End uint32 `json:"end"`
}

type SecurityGroupRuleProtocol string

type SecurityGroupSummary struct {
	// ID: unique ID of the security group.
	ID string `json:"id"`

	// Name: name of the security group.
	Name string `json:"name"`

	// Description: description of the security group.
	Description string `json:"description"`

	// ProjectID: project ID the security group belongs to.
	ProjectID string `json:"project_id"`

	// Tags: tags associated with the security group.
	Tags []string `json:"tags"`

	// DisableDefaultRules: true if default rules are disabled.
	DisableDefaultRules bool `json:"disable_default_rules"`

	// ProjectDefault: true if this is the default security group for the project.
	ProjectDefault bool `json:"project_default"`

	// InboundDefaultAction: default action for inbound rules.
	// Default value: unknown_action
	InboundDefaultAction SecurityGroupAction `json:"inbound_default_action"`

	// OutboundDefaultAction: default action for outbound rules.
	// Default value: unknown_action
	OutboundDefaultAction SecurityGroupAction `json:"outbound_default_action"`

	// Stateless: true if the security group is stateless.
	Stateless bool `json:"stateless"`

	// CreatedAt: creation timestamp of the security group.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the security group.
	UpdatedAt *time.Time `json:"updated_at"`
}

type Server struct {
	// ID: unique ID of the server.
	ID string `json:"id"`

	// Name: name of the server.
	Name string `json:"name"`

	// ProjectID: project ID to which the server belongs.
	ProjectID string `json:"project_id"`

	// Tags: tags associated with the server.
	Tags []string `json:"tags"`

	// ServerType: type of the server.
	ServerType string `json:"server_type"`

	// PlacementGroupID: ID of the placement group the server belongs to.
	PlacementGroupID *string `json:"placement_group_id"`

	// Status: current status of the server.
	// Default value: unknown_status
	Status ServerStatus `json:"status"`

	// Volumes: list of volumes attached to the server.
	Volumes []*ServerVolume `json:"volumes"`

	// Filesystems: list of filesystems attached to the server.
	Filesystems []*ServerFilesystem `json:"filesystems"`

	// Architecture: architecture of the server.
	// Default value: unknown_architecture
	Architecture ServerArchitecture `json:"architecture"`

	// CreatedAt: creation timestamp of the server.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the server.
	UpdatedAt *time.Time `json:"updated_at"`

	// PrivateNetworkInterfaces: list of private network interfaces attached to the server.
	PrivateNetworkInterfaces []*ServerPrivateNetworkInterface `json:"private_network_interfaces"`

	// RescueMode: whether the server is in rescue mode.
	RescueMode bool `json:"rescue_mode"`

	// BootVolumeID: ID of the boot volume.
	BootVolumeID *string `json:"boot_volume_id"`

	// StatusDetail: detailed status information of the server.
	StatusDetail string `json:"status_detail"`

	// WindowsRdpPassword: encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in `windows_rdp_ssh_key_id`.
	WindowsRdpPassword *ServerRDPPassword `json:"windows_rdp_password"`

	// PublicNetworkInterface: public network interface of the server.
	PublicNetworkInterface *ServerPublicNetworkInterface `json:"public_network_interface"`

	// Zone: zone in which the server is located.
	Zone scw.Zone `json:"zone"`
}

type ServerArchitecture string

type ServerFilesystem struct {
	ID string `json:"id"`

	// Status: default value: unknown_status
	Status ServerFilesystemStatus `json:"status"`
}

type ServerFilesystemStatus string

type ServerIP struct {
	ID string `json:"id"`

	Dynamic bool `json:"dynamic"`

	// Status: default value: unknown_status
	Status ServerIPStatus `json:"status"`

	Default bool `json:"default"`
}

type ServerIPStatus string

type ServerPrivateNetworkInterface struct {
	ID string `json:"id"`

	PrivateNetworkID string `json:"private_network_id"`

	MacAddress string `json:"mac_address"`

	// Status: default value: unknown_status
	Status ServerPrivateNetworkInterfaceStatus `json:"status"`

	IPIDs []string `json:"ip_ids"`

	SecurityGroupID string `json:"security_group_id"`
}

type ServerPrivateNetworkInterfaceStatus string

type ServerPublicNetworkInterface struct {
	// Status: default value: unknown_status
	Status ServerPublicNetworkInterfaceStatus `json:"status"`

	MacAddress string `json:"mac_address"`

	SecurityGroupID string `json:"security_group_id"`

	IPs []*ServerIP `json:"ips"`

	DNS string `json:"dns"`
}

type ServerPublicNetworkInterfaceStatus string

type ServerRDPPassword struct {
	EncryptedPassword string `json:"encrypted_password"`

	RdpSSHKeyID string `json:"rdp_ssh_key_id"`
}

type ServerStatus string

type ServerSummary struct {
	// ID: unique ID of the server.
	ID string `json:"id"`

	// Name: name of the server.
	Name string `json:"name"`

	// ProjectID: project ID to which the server belongs.
	ProjectID string `json:"project_id"`

	// Tags: tags associated with the server.
	Tags []string `json:"tags"`

	// ServerType: type of the server.
	ServerType string `json:"server_type"`

	// PlacementGroupID: ID of the placement group the server belongs to.
	PlacementGroupID *string `json:"placement_group_id"`

	// Status: current status of the server.
	// Default value: unknown_status
	Status ServerStatus `json:"status"`

	// Architecture: architecture of the server.
	// Default value: unknown_architecture
	Architecture ServerArchitecture `json:"architecture"`

	// CreatedAt: creation timestamp of the server.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the server.
	UpdatedAt *time.Time `json:"updated_at"`

	// RescueMode: whether the server is in rescue mode.
	RescueMode bool `json:"rescue_mode"`
}

type ServerType struct {
	// Name: name of the server type.
	Name string `json:"name"`

	// VcpuCount: number of vCPUs.
	VcpuCount uint32 `json:"vcpu_count"`

	// GpuCount: number of GPUs.
	GpuCount uint32 `json:"gpu_count"`

	// Memory: amount of memory.
	Memory scw.Size `json:"memory"`

	// Architecture: architecture of the server type.
	// Default value: unknown_architecture
	Architecture ServerTypeArchitecture `json:"architecture"`

	// Availability: availability status of the server type.
	// Default value: unknown_availability
	Availability ServerTypeAvailability `json:"availability"`

	// Limits: limits for the server type.
	Limits *ServerTypeLimits `json:"limits"`

	// GpuInfo: gPU information for the server type.
	GpuInfo *ServerTypeGpuInfo `json:"gpu_info"`

	// EndOfService: whether the server type has reached end of service.
	EndOfService bool `json:"end_of_service"`
}

type ServerTypeArchitecture string

type ServerTypeAvailability string

type ServerTypeGpuInfo struct {
	// Manufacturer: manufacturer of the GPU.
	Manufacturer string `json:"manufacturer"`

	// Name: name of the GPU.
	Name string `json:"name"`

	// Memory: memory of the GPU.
	Memory scw.Size `json:"memory"`
}

type ServerTypeLimits struct {
	// PrivateNetworkCount: maximum number of Private Networks.
	PrivateNetworkCount uint32 `json:"private_network_count"`

	// FileSystemCount: maximum number of filesystems.
	FileSystemCount uint32 `json:"file_system_count"`

	// PrivateNetworkBandwidth: maximum Private Network bandwidth.
	PrivateNetworkBandwidth uint64 `json:"private_network_bandwidth"`

	// BlockBandwidth: maximum block storage bandwidth.
	BlockBandwidth uint64 `json:"block_bandwidth"`

	// InternetBandwidth: maximum internet bandwidth.
	InternetBandwidth uint64 `json:"internet_bandwidth"`

	// LSSDSize: maximum size of local SSD.
	LSSDSize scw.Size `json:"l_ssd_size"`

	// ScratchSize: maximum size of scratch storage.
	ScratchSize scw.Size `json:"scratch_size"`

	// ScratchVolumesCount: maximum number of scratch volumes.
	ScratchVolumesCount uint32 `json:"scratch_volumes_count"`

	// IPCount: maximum number of IPs.
	IPCount uint32 `json:"ip_count"`

	// VolumeCount: maximum number of volumes.
	VolumeCount uint32 `json:"volume_count"`
}

type ServerVolume struct {
	ID string `json:"id"`

	// VolumeType: default value: unknown_volume_type
	VolumeType ServerVolumeVolumeType `json:"volume_type"`
}

type ServerVolumeVolumeType string

type SetSecurityGroupRulesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupID: ID of the security group to set rules for.
	SecurityGroupID string `json:"security_group_id"`

	// SecurityGroupRules: list of rules to set.
	SecurityGroupRules []*SecurityGroupRuleConfig `json:"security_group_rules"`
}

type SetServerCloudInitRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: the ID of the server.
	ServerID string `json:"-"`

	// Content: the cloud-init configuration content.
	Content []byte `json:"content"`
}

type SetServerDefaultIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to set the default IP for.
	ServerID string `json:"-"`

	// IPID: ID of the IP to set as default.
	IPID string `json:"ip_id"`
}

type SetTemplateCloudInitRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template.
	TemplateID string `json:"-"`

	// Content: cloud-init configuration content.
	Content []byte `json:"content"`
}

type SetTemplateUserDataRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template.
	TemplateID string `json:"-"`

	// Key: key of the user data to set.
	Key string `json:"-"`

	// Content: content of the user data.
	Content []byte `json:"content"`
}

type SetUserDataRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: the ID of the server.
	ServerID string `json:"-"`

	// Key: the key of the user data to set.
	Key string `json:"-"`

	// Content: the content to set for the user data.
	Content []byte `json:"content"`
}

type Snapshot struct {
	// ID: unique ID of the snapshot.
	ID string `json:"id"`

	// ProjectID: project ID of the snapshot.
	ProjectID string `json:"project_id"`

	// Name: name of the snapshot.
	Name string `json:"name"`

	// Tags: tags associated with the snapshot.
	Tags []string `json:"tags"`

	// Size: size of the snapshot in bytes.
	Size scw.Size `json:"size"`

	// Status: current status of the snapshot.
	// Default value: unknown_status
	Status SnapshotStatus `json:"status"`

	// BaseVolumeID: ID of the base volume.
	BaseVolumeID *string `json:"base_volume_id"`

	// VolumeType: type of the volume.
	// Default value: unknown_volume_type
	VolumeType SnapshotVolumeType `json:"volume_type"`

	// CreatedAt: creation date of the snapshot.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update date of the snapshot.
	UpdatedAt *time.Time `json:"updated_at"`

	// Zone: zone in which the snapshot is located.
	Zone scw.Zone `json:"zone"`

	// Public: whether the snapshot is public.
	Public bool `json:"public"`
}

type SnapshotStatus string

type SnapshotVolumeType string

type StartServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to start.
	ServerID string `json:"-"`
}

type StopAndDeleteServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to stop and delete.
	ServerID string `json:"-"`

	// DeleteAllIPs: whether to delete all IPs attached to the server.
	// Precisely one of DeleteAllIPs, DeleteIPIDs must be set.
	DeleteAllIPs *bool `json:"delete_all_ips,omitempty"`

	// DeleteIPIDs: list of IP IDs to delete.
	// Precisely one of DeleteAllIPs, DeleteIPIDs must be set.
	DeleteIPIDs *[]string `json:"delete_ip_ids,omitempty"`

	// DeleteAllVolumes: whether to delete all volumes attached to the server.
	// Precisely one of DeleteAllVolumes, DeleteVolumeIDs must be set.
	DeleteAllVolumes *bool `json:"delete_all_volumes,omitempty"`

	// DeleteVolumeIDs: list of volume IDs to delete.
	// Precisely one of DeleteAllVolumes, DeleteVolumeIDs must be set.
	DeleteVolumeIDs *[]string `json:"delete_volume_ids,omitempty"`

	// KeepAllPrivateNics: whether to keep all private network interfaces.
	// Precisely one of KeepAllPrivateNics, DeletePrivateNicIDs must be set.
	KeepAllPrivateNics *bool `json:"keep_all_private_nics,omitempty"`

	// DeletePrivateNicIDs: list of private network interface IDs to delete.
	// Precisely one of KeepAllPrivateNics, DeletePrivateNicIDs must be set.
	DeletePrivateNicIDs *[]string `json:"delete_private_nic_ids,omitempty"`
}

type StopServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to stop.
	ServerID string `json:"-"`
}

type Template struct {
	// ProjectID: project ID associated with the template.
	ProjectID string `json:"project_id"`

	// ID: unique ID of the template.
	ID string `json:"id"`

	// Name: name of the template.
	Name string `json:"name"`

	// Tags: tags associated with the template.
	Tags []string `json:"tags"`

	// ServerTags: tags associated with servers created from this template.
	ServerTags []string `json:"server_tags"`

	// ServerType: commercial type of the server defined by the template.
	ServerType string `json:"server_type"`

	// SecurityGroupID: security group ID associated with the template.
	SecurityGroupID *string `json:"security_group_id"`

	// PlacementGroupID: placement group ID associated with the template.
	PlacementGroupID *string `json:"placement_group_id"`

	// PublicIPV4Count: number of IPv4 public IPs to attach to servers created from this template.
	PublicIPV4Count uint32 `json:"public_ip_v4_count"`

	// PublicIPV6Count: number of IPv6 public IPs to attach to servers created from this template.
	PublicIPV6Count uint32 `json:"public_ip_v6_count"`

	// Volumes: list of volume templates used to create volumes for servers.
	Volumes []*CreateTemplateRequestVolumeTemplate `json:"volumes"`

	// PrivateNetworks: list of private network associated with the template.
	PrivateNetworks []*CreateTemplateRequestPrivateNetworkTemplate `json:"private_networks"`

	// FilesystemIDs: list of filesystem IDs associated with the template.
	FilesystemIDs []string `json:"filesystem_ids"`

	// CreatedAt: creation timestamp of the template.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the template.
	UpdatedAt *time.Time `json:"updated_at"`

	// WindowsRdpSSHKeyID: iAM ID of the SSH key used to encrypt the Windows `Administrator` password for RDP use.
	WindowsRdpSSHKeyID *string `json:"windows_rdp_ssh_key_id"`

	// Zone: zone in which the template is located.
	Zone scw.Zone `json:"zone"`
}

type TemplateSummary struct {
	// ProjectID: project ID associated with the template.
	ProjectID string `json:"project_id"`

	// ID: unique ID of the template.
	ID string `json:"id"`

	// Name: name of the template.
	Name string `json:"name"`

	// Tags: tags associated with the template.
	Tags []string `json:"tags"`

	// ServerTags: tags associated with servers created from this template.
	ServerTags []string `json:"server_tags"`

	// ServerType: commercial type of the server defined by the template.
	ServerType string `json:"server_type"`

	// SecurityGroupID: security group ID associated with the template.
	SecurityGroupID *string `json:"security_group_id"`

	// PlacementGroupID: placement group ID associated with the template.
	PlacementGroupID *string `json:"placement_group_id"`

	// PublicIPV4Count: number of IPv4 public IPs to attach to servers created from this template.
	PublicIPV4Count uint32 `json:"public_ip_v4_count"`

	// PublicIPV6Count: number of IPv6 public IPs to attach to servers created from this template.
	PublicIPV6Count uint32 `json:"public_ip_v6_count"`

	// FilesystemIDs: list of Filesystem IDs associated with the template.
	FilesystemIDs []string `json:"filesystem_ids"`

	// CreatedAt: creation timestamp of the template.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update timestamp of the template.
	UpdatedAt *time.Time `json:"updated_at"`

	// Zone: zone in which the template is located.
	Zone scw.Zone `json:"zone"`
}

type UpdatePlacementGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PlacementGroupID: UUID of the placement group.
	PlacementGroupID string `json:"-"`

	// Name: name of the placement group.
	Name *string `json:"name,omitempty"`

	// PolicyType: policy type of the placement group.
	// Default value: unknown_policy_type
	PolicyType PlacementGroupPolicyType `json:"policy_type"`

	// Tags: tags of the placement group.
	Tags *[]string `json:"tags,omitempty"`
}

type UpdatePrivateNetworkInterfaceRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PrivateNetworkInterfaceID: ID of the private network interface to update.
	PrivateNetworkInterfaceID string `json:"-"`

	// Tags: new tags to assign to the private network interface.
	Tags *[]string `json:"tags,omitempty"`
}

type UpdateSecurityGroupRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupID: ID of the security group to update.
	SecurityGroupID string `json:"-"`

	// Name: new name for the security group.
	Name *string `json:"name,omitempty"`

	// Description: new description for the security group.
	Description *string `json:"description,omitempty"`

	// DisableDefaultRules: whether to disable default rules.
	DisableDefaultRules *bool `json:"disable_default_rules,omitempty"`

	// Tags: new tags for the security group.
	Tags *[]string `json:"tags,omitempty"`

	// ProjectDefault: whether this should be the default security group for the project.
	ProjectDefault *bool `json:"project_default,omitempty"`

	// InboundDefaultAction: new default action for inbound rules.
	// Default value: unknown_action
	InboundDefaultAction SecurityGroupAction `json:"inbound_default_action"`

	// OutboundDefaultAction: new default action for outbound rules.
	// Default value: unknown_action
	OutboundDefaultAction SecurityGroupAction `json:"outbound_default_action"`

	// Stateless: whether the security group should be stateless.
	Stateless *bool `json:"stateless,omitempty"`
}

type UpdateSecurityGroupRuleRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SecurityGroupRuleID: ID of the rule to update.
	SecurityGroupRuleID string `json:"-"`

	// Protocol: new protocol for the rule.
	// Default value: unknown_protocol
	Protocol SecurityGroupRuleProtocol `json:"protocol"`

	// Direction: new direction for the rule.
	// Default value: unknown_direction
	Direction SecurityGroupRuleDirection `json:"direction"`

	// Action: new action for the rule.
	// Default value: unknown_action
	Action SecurityGroupRuleAction `json:"action"`

	// SourceIPRange: new source IP range for the rule.
	SourceIPRange *scw.IPNet `json:"source_ip_range,omitempty"`

	// DestinationIPRange: new destination IP range for the rule.
	DestinationIPRange *scw.IPNet `json:"destination_ip_range,omitempty"`

	// SourcePorts: new source port range for the rule.
	SourcePorts *SecurityGroupRulePortRange `json:"source_ports,omitempty"`

	// DestinationPorts: new destination port range for the rule.
	DestinationPorts *SecurityGroupRulePortRange `json:"destination_ports,omitempty"`

	// Position: new position for the rule.
	Position *int32 `json:"position,omitempty"`
}

type UpdateServerRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ServerID: ID of the server to update.
	ServerID string `json:"-"`

	// Name: new name for the server.
	Name *string `json:"name,omitempty"`

	// Tags: new tags for the server.
	Tags *[]string `json:"tags,omitempty"`

	// ServerType: new server type.
	ServerType *string `json:"server_type,omitempty"`

	// PlacementGroupID: new placement group ID.
	PlacementGroupID *string `json:"placement_group_id,omitempty"`

	// RescueMode: new rescue mode setting.
	RescueMode *bool `json:"rescue_mode,omitempty"`

	// BootVolumeID: new boot volume ID.
	BootVolumeID *string `json:"boot_volume_id,omitempty"`

	// WindowsRdpSSHKeyID: new IAM ID of the SSH key used to encrypt the Windows `Administrator` password for RDP use.
	WindowsRdpSSHKeyID *string `json:"windows_rdp_ssh_key_id,omitempty"`

	// Protected: protection status of the server.
	Protected *bool `json:"protected,omitempty"`

	// PublicNetworkInterface: new public network interface configuration.
	PublicNetworkInterface *UpdateServerRequestPublicNetworkInterface `json:"public_network_interface,omitempty"`
}

type UpdateServerRequestPublicNetworkInterface struct {
	// SecurityGroupID: ID of the security group for the interface.
	SecurityGroupID *string `json:"security_group_id"`
}

type UpdateTemplateRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// TemplateID: unique ID of the template to update.
	TemplateID string `json:"-"`

	// Name: new name for the template.
	Name *string `json:"name,omitempty"`

	// Tags: new tags for the template.
	Tags *[]string `json:"tags,omitempty"`

	// ServerTags: new server tags for the template.
	ServerTags *[]string `json:"server_tags,omitempty"`

	// ServerType: new server type for the template.
	ServerType *string `json:"server_type,omitempty"`

	// SecurityGroupID: new security group ID for the template.
	SecurityGroupID *string `json:"security_group_id,omitempty"`

	// PlacementGroupID: new placement group ID for the template.
	PlacementGroupID *string `json:"placement_group_id,omitempty"`

	// UpdateVolumes: updated volume templates for the template.
	UpdateVolumes *UpdateTemplateRequestUpdateVolumes `json:"update_volumes,omitempty"`

	// UpdatePrivateNetworks: updated private networks list for the template.
	UpdatePrivateNetworks *UpdateTemplateRequestUpdatePrivateNetworks `json:"update_private_networks,omitempty"`

	// FilesystemIDs: new list of filesystem IDs for the template.
	FilesystemIDs *[]string `json:"filesystem_ids,omitempty"`

	// PublicIPV4Count: new number of IPv4 public IPs to attach to servers.
	PublicIPV4Count *uint32 `json:"public_ip_v4_count,omitempty"`

	// PublicIPV6Count: new number of IPv6 public IPs to attach to servers.
	PublicIPV6Count *uint32 `json:"public_ip_v6_count,omitempty"`

	// WindowsRdpSSHKeyID: new IAM ID of the SSH key used to encrypt the Windows `Administrator` password for RDP use.
	WindowsRdpSSHKeyID *string `json:"windows_rdp_ssh_key_id,omitempty"`
}

type UpdateTemplateRequestUpdatePrivateNetworks struct {
	// PrivateNetworks: list of updated private networks.
	PrivateNetworks []*CreateTemplateRequestPrivateNetworkTemplate `json:"private_networks"`
}

type UpdateTemplateRequestUpdateVolumes struct {
	// Volumes: list of updated volume templates.
	Volumes []*CreateTemplateRequestVolumeTemplate `json:"volumes"`
}

type UserData struct {
	// Key: the key of the user data.
	Key string `json:"key"`

	// Content: the content of the user data.
	Content []byte `json:"content"`
}

type Volume struct {
	// ID: unique ID of the volume.
	ID string `json:"id"`

	// ProjectID: project ID to which the volume belongs.
	ProjectID string `json:"project_id"`

	// Name: volume name.
	Name string `json:"name"`

	// Tags: tags associated with the volume.
	Tags []string `json:"tags"`

	// Size: volume size in bytes.
	Size scw.Size `json:"size"`

	// BaseSnapshotID: ID of the base snapshot used for this volume.
	BaseSnapshotID *string `json:"base_snapshot_id"`

	// Status: current status of the volume.
	// Default value: unknown_status
	Status VolumeStatus `json:"status"`

	// VolumeType: type of the volume.
	// Default value: unknown_volume_type
	VolumeType VolumeVolumeType `json:"volume_type"`

	// CreatedAt: creation date of the volume.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update date of the volume.
	UpdatedAt *time.Time `json:"updated_at"`

	// ServerID: ID of the Instance to which the volume is attached.
	ServerID *string `json:"server_id"`

	// Zone: zone in which the volume is located.
	Zone scw.Zone `json:"zone"`
}

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

type VolumeAPICreateSnapshotRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ProjectID: project ID of the snapshot.
	ProjectID string `json:"project_id"`

	// Name: name of the snapshot.
	Name string `json:"name"`

	// Tags: tags associated with the snapshot.
	Tags []string `json:"tags"`

	// BaseVolumeID: ID of the base volume.
	BaseVolumeID string `json:"base_volume_id"`

	// Public: whether the snapshot should be public.
	Public bool `json:"public"`
}

type VolumeAPICreateVolumeRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ProjectID: project ID to which the volume belongs.
	ProjectID string `json:"project_id"`

	// Name: volume name.
	Name string `json:"name"`

	// Tags: tags associated with the volume.
	Tags []string `json:"tags"`

	// Size: volume size in bytes.
	Size *scw.Size `json:"size,omitempty"`

	// BaseSnapshotID: ID of the base snapshot used for this volume.
	BaseSnapshotID *string `json:"base_snapshot_id,omitempty"`

	// VolumeType: type of the volume.
	// Default value: unknown_volume_type
	VolumeType CreateVolumeRequestVolumeType `json:"volume_type"`
}

type VolumeAPIDeleteSnapshotRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SnapshotID: ID of the snapshot to delete.
	SnapshotID string `json:"-"`
}

type VolumeAPIDeleteVolumeRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// VolumeID: ID of the volume to delete.
	VolumeID string `json:"-"`
}

type VolumeAPIExportSnapshotToObjectStorageRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SnapshotID: ID of the snapshot to export.
	SnapshotID string `json:"-"`

	// Bucket: object Storage bucket name.
	Bucket string `json:"bucket"`

	// ObjectKey: object key.
	ObjectKey string `json:"object_key"`
}

type VolumeAPIGetSnapshotRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SnapshotID: ID of the snapshot to retrieve.
	SnapshotID string `json:"-"`
}

type VolumeAPIGetVolumeRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// VolumeID: ID of the volume to retrieve.
	VolumeID string `json:"-"`
}

type VolumeAPIImportSnapshotFromObjectStorageRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// ProjectID: project ID of the snapshot.
	ProjectID string `json:"project_id"`

	// Name: name of the snapshot.
	Name string `json:"name"`

	// Tags: tags associated with the snapshot.
	Tags []string `json:"tags"`

	// Bucket: object Storage bucket name.
	Bucket string `json:"bucket"`

	// ObjectKey: object key.
	ObjectKey string `json:"object_key"`

	// Size: size of the imported snapshot in bytes.
	Size *scw.Size `json:"size,omitempty"`

	// VolumeType: volume type of the snapshot.
	// Default value: unknown_volume_type
	VolumeType SnapshotVolumeType `json:"volume_type"`
}

type VolumeAPIListSnapshotsRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of snapshots to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: field to sort by.
	// Default value: created_at_desc
	OrderBy ListSnapshotsRequestOrderBy `json:"-"`

	// ProjectID: filter by Project ID.
	ProjectID string `json:"-"`

	// SnapshotIDs: filter by specific snapshot IDs.
	SnapshotIDs []string `json:"-"`

	// Name: filter by name.
	Name *string `json:"-"`

	// Tags: filter by tags.
	Tags []string `json:"-"`

	// BaseVolumeID: filter by base volume ID.
	BaseVolumeID *string `json:"-"`
}

type VolumeAPIListVolumeTypesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`
}

type VolumeAPIListVolumesRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// PageToken: token for pagination.
	PageToken *string `json:"-"`

	// PageSize: number of items to return per page.
	PageSize *uint32 `json:"-"`

	// OrderBy: field to order the results by.
	// Default value: created_at_desc
	OrderBy ListVolumesRequestOrderBy `json:"-"`

	// ProjectID: filter by Project ID.
	ProjectID string `json:"-"`

	// VolumeIDs: filter by specific volume IDs.
	VolumeIDs []string `json:"-"`

	// Name: filter by volume name.
	Name *string `json:"-"`

	// Tags: filter by tags.
	Tags []string `json:"-"`

	// VolumeType: filter by volume type.
	// Default value: unknown_volume_type
	VolumeType *VolumeVolumeType `json:"-"`
}

type VolumeAPIUpdateSnapshotRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// SnapshotID: ID of the snapshot to update.
	SnapshotID string `json:"-"`

	// Name: new name for the snapshot.
	Name *string `json:"name,omitempty"`

	// Tags: new tags for the snapshot.
	Tags *[]string `json:"tags,omitempty"`

	// Public: whether the snapshot should be public.
	Public *bool `json:"public,omitempty"`
}

type VolumeAPIUpdateVolumeRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	// VolumeID: ID of the volume to update.
	VolumeID string `json:"-"`

	// Name: new name for the volume.
	Name *string `json:"name,omitempty"`

	// Tags: new tags for the volume.
	Tags *[]string `json:"tags,omitempty"`

	// Size: new size for the volume.
	Size *scw.Size `json:"size,omitempty"`
}

type VolumeStatus string

type VolumeType struct {
	// Name: name of the volume type.
	// Default value: unknown_volume_type
	Name VolumeVolumeType `json:"name"`

	// MinSize: minimum size of the volume in bytes.
	MinSize uint64 `json:"min_size"`

	// MaxSize: maximum size of the volume in bytes.
	MaxSize uint64 `json:"max_size"`
}

type VolumeVolumeType string

type WaitForPrivateNetworkInterfaceRequest struct {
	Zone                      scw.Zone
	PrivateNetworkInterfaceID string
	Timeout                   *time.Duration
	RetryInterval             *time.Duration
}

type WaitForServerRequest struct {
	Zone          scw.Zone
	ServerID      string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForSnapshotRequest struct {
	Zone          scw.Zone
	SnapshotID    string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForVolumeRequest struct {
	Zone          scw.Zone
	VolumeID      string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}