marketplace

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

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

	Name string `json:"name"`

	Description string `json:"description"`
}

type GetCategoryRequest struct {
	CategoryID string `json:"-"`
}

type GetImageRequest struct {
	// ImageID: display the image name
	ImageID string `json:"-"`
}

type GetLocalImageRequest struct {
	LocalImageID string `json:"-"`
}

type GetVersionRequest struct {
	VersionID string `json:"-"`
}

type Image struct {
	// ID: UUID of this image
	ID string `json:"id"`
	// Name: name of the image
	Name string `json:"name"`
	// Description: text description of this image
	Description string `json:"description"`
	// Logo: URL of this image's logo
	Logo string `json:"logo"`
	// Categories: list of categories this image belongs to
	Categories []string `json:"categories"`
	// CreatedAt: creation date of this image
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: date of the last modification of this image
	UpdatedAt *time.Time `json:"updated_at"`
	// ValidUntil: expiration date of this image
	ValidUntil *time.Time `json:"valid_until"`
	// Label: label of this image
	//
	// Typically an identifier for a distribution (ex. "ubuntu_focal").
	//
	Label string `json:"label"`
}

type ListCategoriesRequest struct {
	PageSize *uint32 `json:"-"`

	Page *int32 `json:"-"`
}

type ListCategoriesResponse struct {
	Categories []*Category `json:"categories"`

	TotalCount uint32 `json:"total_count"`
}

type ListImagesRequest struct {
	// PageSize: a positive integer lower or equal to 100 to select the number of items to display
	PageSize *uint32 `json:"-"`
	// Page: a positive integer to choose the page to display
	Page *int32 `json:"-"`
	// OrderBy: ordering to use
	//
	// Default value: name_asc
	OrderBy ListImagesRequestOrderBy `json:"-"`
	// Arch: choose for which machine architecture to return images
	Arch *string `json:"-"`
	// Category: choose the category of images to get
	Category *string `json:"-"`
	// IncludeEol: choose to include end-of-life images
	IncludeEol bool `json:"-"`
}

type ListImagesRequestOrderBy string

type ListImagesResponse struct {
	Images []*Image `json:"images"`

	TotalCount uint32 `json:"total_count"`
}

type ListLocalImagesRequest struct {
	ImageID *string `json:"-"`

	VersionID *string `json:"-"`

	PageSize *uint32 `json:"-"`

	Page *int32 `json:"-"`
	// OrderBy:
	//
	// Default value: created_at_asc
	OrderBy ListLocalImagesRequestOrderBy `json:"-"`
}

type ListLocalImagesRequestOrderBy string

type ListLocalImagesResponse struct {
	LocalImages []*LocalImage `json:"local_images"`

	TotalCount uint32 `json:"total_count"`
}

type ListVersionsRequest struct {
	ImageID string `json:"-"`

	PageSize *uint32 `json:"-"`

	Page *int32 `json:"-"`
	// OrderBy:
	//
	// Default value: created_at_asc
	OrderBy ListVersionsRequestOrderBy `json:"-"`
}

type ListVersionsRequestOrderBy string

type ListVersionsResponse struct {
	Versions []*Version `json:"versions"`

	TotalCount uint32 `json:"total_count"`
}

type LocalImage struct {
	// ID: UUID of this local image
	//
	// Version you will typically use to define an image in an API call.
	//
	ID string `json:"id"`
	// CompatibleCommercialTypes: list of all commercial types that are compatible with this local image
	CompatibleCommercialTypes []string `json:"compatible_commercial_types"`
	// Arch: supported architecture for this local image
	Arch string `json:"arch"`
	// Zone: availability Zone where this local image is available
	Zone scw.Zone `json:"zone"`
}

type Version struct {
	// ID: UUID of this version
	ID string `json:"id"`
	// Name: name of this version
	Name string `json:"name"`
	// CreatedAt: creation date of this image version
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: date of the last modification of this version
	UpdatedAt *time.Time `json:"updated_at"`
	// PublishedAt: date this version was officially published
	PublishedAt *time.Time `json:"published_at"`
}