webhosting

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

type CreateHostingRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// OfferID: ID of the selected offer for the hosting.
	OfferID string `json:"offer_id"`
	// ProjectID: project ID of the hosting.
	ProjectID string `json:"project_id"`
	// Email: contact email of the client for the hosting.
	Email *string `json:"email"`
	// Tags: the tags of the hosting.
	Tags []string `json:"tags"`
	// Domain: the domain name of the hosting.
	Domain string `json:"domain"`
	// OptionIDs: iDs of the selected options for the hosting.
	OptionIDs []string `json:"option_ids"`
}

type DNSRecord struct {
	// Name: record name.
	Name string `json:"name"`
	// Type: record type.
	// Default value: unknown_type
	Type DNSRecordType `json:"type"`
	// TTL: record time to live.
	TTL uint32 `json:"ttl"`
	// Value: record value.
	Value string `json:"value"`
	// Priority: record priority level.
	Priority *uint32 `json:"priority"`
	// Status: record status.
	// Default value: unknown_status
	Status DNSRecordStatus `json:"status"`
}

type DNSRecordStatus string

type DNSRecordType string

type DNSRecords struct {
	// Records: list of DNS records.
	Records []*DNSRecord `json:"records"`
	// NameServers: list of nameservers.
	NameServers []*Nameserver `json:"name_servers"`
	// Status: status of the records.
	// Default value: unknown
	Status DNSRecordsStatus `json:"status"`
}

type DNSRecordsStatus string

type DeleteHostingRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// HostingID: hosting ID.
	HostingID string `json:"-"`
}

type GetDomainDNSRecordsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Domain: domain associated to the DNS records.
	Domain string `json:"-"`
}

type GetHostingRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// HostingID: hosting ID.
	HostingID string `json:"-"`
}

type Hosting struct {
	// ID: ID of the hosting.
	ID string `json:"id"`
	// OrganizationID: organization ID of the hosting.
	OrganizationID string `json:"organization_id"`
	// ProjectID: project ID of the hosting.
	ProjectID string `json:"project_id"`
	// UpdatedAt: last update date.
	UpdatedAt *time.Time `json:"updated_at"`
	// CreatedAt: creation date.
	CreatedAt *time.Time `json:"created_at"`
	// Status: the hosting status.
	// Default value: unknown_status
	Status HostingStatus `json:"status"`
	// PlatformHostname: hostname of the host platform.
	PlatformHostname string `json:"platform_hostname"`
	// PlatformNumber: number of the host platform.
	PlatformNumber *int32 `json:"platform_number"`
	// OfferID: ID of the active offer.
	OfferID string `json:"offer_id"`
	// OfferName: name of the active offer.
	OfferName string `json:"offer_name"`
	// Domain: main domain of the hosting.
	Domain string `json:"domain"`
	// Tags: tags of the hosting.
	Tags []string `json:"tags"`
	// Options: active options of the hosting.
	Options []*HostingOption `json:"options"`
	// DNSStatus: DNS status of the hosting.
	// Default value: unknown_dns_status
	DNSStatus HostingDNSStatus `json:"dns_status"`
	// CpanelURLs: URL to connect to cPanel Dashboard and to Webmail interface.
	CpanelURLs *HostingCpanelURLs `json:"cpanel_urls"`
	// Username: main hosting cPanel username.
	Username string `json:"username"`
	// Region: region of the hosting.
	Region scw.Region `json:"region"`
}

type HostingCpanelURLs struct {
	Dashboard string `json:"dashboard"`

	Webmail string `json:"webmail"`
}

type HostingDNSStatus string

type HostingOption struct {
	// ID: option ID.
	ID string `json:"id"`
	// Name: option name.
	Name string `json:"name"`
}

type HostingStatus string

type ListHostingsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: a positive integer to choose the page to return.
	Page *int32 `json:"-"`
	// PageSize: a positive integer lower or equal to 100 to select the number of items to return.
	PageSize *uint32 `json:"-"`
	// OrderBy: define the order of the returned hostings.
	// Default value: created_at_asc
	OrderBy ListHostingsRequestOrderBy `json:"-"`
	// Tags: return hostings with these tags.
	Tags *[]string `json:"-"`
	// Statuses: return hostings with these statuses.
	Statuses []HostingStatus `json:"-"`
	// Domain: return hostings with this domain.
	Domain *string `json:"-"`
	// ProjectID: return hostings from this project ID.
	ProjectID *string `json:"-"`
	// OrganizationID: return hostings from this organization ID.
	OrganizationID *string `json:"-"`
}

type ListHostingsRequestOrderBy string

type ListHostingsResponse struct {
	// TotalCount: number of returned hostings.
	TotalCount uint32 `json:"total_count"`
	// Hostings: list of hostings.
	Hostings []*Hosting `json:"hostings"`
}

type ListOffersRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// OrderBy: define the order of the returned hostings.
	// Default value: price_asc
	OrderBy ListOffersRequestOrderBy `json:"-"`
	// WithoutOptions: select only offers, no options.
	WithoutOptions bool `json:"-"`
	// OnlyOptions: select only options.
	OnlyOptions bool `json:"-"`
	// HostingID: define a specific hosting id (optional).
	HostingID *string `json:"-"`
}

type ListOffersRequestOrderBy string

type ListOffersResponse struct {
	// Offers: list of returned offers.
	Offers []*Offer `json:"offers"`
}

type Nameserver struct {
	// Hostname: hostname of the nameserver.
	Hostname string `json:"hostname"`
	// Status: status of the nameserver.
	// Default value: unknown_status
	Status NameserverStatus `json:"status"`
	// IsDefault: if the nameserver is the default.
	IsDefault bool `json:"is_default"`
}

type NameserverStatus string

type Offer struct {
	// ID: offer ID.
	ID string `json:"id"`
	// BillingOperationPath: unique identifier used for billing.
	BillingOperationPath string `json:"billing_operation_path"`
	// Product: offer product.
	Product *OfferProduct `json:"product"`
	// Price: offer price.
	Price *scw.Money `json:"price"`
	// Available: if offer is available for a specific hosting.
	Available bool `json:"available"`
	// QuotaWarnings: if not available, return quota warnings.
	QuotaWarnings []OfferQuotaWarning `json:"quota_warnings"`
}

type OfferProduct struct {
	// Name: product name.
	Name string `json:"name"`
	// Option: product option.
	Option bool `json:"option"`

	EmailAccountsQuota int32 `json:"email_accounts_quota"`

	EmailStorageQuota int32 `json:"email_storage_quota"`

	DatabasesQuota int32 `json:"databases_quota"`

	HostingStorageQuota uint32 `json:"hosting_storage_quota"`

	SupportIncluded bool `json:"support_included"`

	VCPU uint32 `json:"v_cpu"`

	RAM uint32 `json:"ram"`
}

type OfferQuotaWarning string

type RestoreHostingRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// HostingID: hosting ID.
	HostingID string `json:"-"`
}

type UpdateHostingRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// HostingID: hosting ID.
	HostingID string `json:"-"`
	// Email: new contact email for the hosting.
	Email *string `json:"email"`
	// Tags: new tags for the hosting.
	Tags *[]string `json:"tags"`
	// OptionIDs: new options IDs for the hosting.
	OptionIDs *[]string `json:"option_ids"`
	// OfferID: new offer ID for the hosting.
	OfferID *string `json:"offer_id"`
}

type WaitForHostingRequest struct {
	HostingID     string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}