cockpit

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

type ActivateCockpitRequest struct {
	// ProjectID: ID of the Project the Cockpit belongs to.
	ProjectID string `json:"project_id"`
}

type Cockpit struct {
	// ProjectID: ID of the Project the Cockpit belongs to.
	ProjectID string `json:"project_id"`
	// CreatedAt: date and time of the Cockpit's creation.
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: date and time of the Cockpit's last update.
	UpdatedAt *time.Time `json:"updated_at"`
	// Endpoints: endpoints of the Cockpit.
	Endpoints *CockpitEndpoints `json:"endpoints"`
	// Status: status of the Cockpit.
	// Default value: unknown_status
	Status CockpitStatus `json:"status"`
	// ManagedAlertsEnabled: specifies whether managed alerts are enabled or disabled.
	ManagedAlertsEnabled bool `json:"managed_alerts_enabled"`
	// Plan: pricing plan information.
	Plan *Plan `json:"plan"`
}

type CockpitEndpoints struct {
	// MetricsURL: URL for metrics.
	MetricsURL string `json:"metrics_url"`
	// LogsURL: URL for logs.
	LogsURL string `json:"logs_url"`
	// AlertmanagerURL: URL for the alert manager.
	AlertmanagerURL string `json:"alertmanager_url"`
	// GrafanaURL: URL for the Grafana dashboard.
	GrafanaURL string `json:"grafana_url"`
}

type CockpitMetrics struct {
	// Timeseries: time series array.
	Timeseries []*scw.TimeSeries `json:"timeseries"`
}

type CockpitStatus string

type ContactPoint struct {
	// Email: contact point configuration.
	// Precisely one of Email must be set.
	Email *ContactPointEmail `json:"email,omitempty"`
}

type ContactPointEmail struct {
	To string `json:"to"`
}

type CreateContactPointRequest struct {
	// ProjectID: ID of the Project in which to create the contact point.
	ProjectID string `json:"project_id"`
	// ContactPoint: contact point to create.
	ContactPoint *ContactPoint `json:"contact_point"`
}

type CreateGrafanaUserRequest struct {
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
	// Login: username of the Grafana user.
	Login string `json:"login"`
	// Role: role assigned to the Grafana user.
	// Default value: unknown_role
	Role GrafanaUserRole `json:"role"`
}

type CreateTokenRequest struct {
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
	// Name: name of the token.
	Name string `json:"name"`
	// Scopes: token's permissions.
	Scopes *TokenScopes `json:"scopes"`
}

type DeactivateCockpitRequest struct {
	// ProjectID: ID of the Project the Cockpit belongs to.
	ProjectID string `json:"project_id"`
}

type DeleteContactPointRequest struct {
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
	// ContactPoint: contact point to delete.
	ContactPoint *ContactPoint `json:"contact_point"`
}

type DeleteGrafanaUserRequest struct {
	// GrafanaUserID: ID of the Grafana user.
	GrafanaUserID uint32 `json:"-"`
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
}

type DeleteTokenRequest struct {
	// TokenID: ID of the token.
	TokenID string `json:"-"`
}

type DisableManagedAlertsRequest struct {
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
}

type EnableManagedAlertsRequest struct {
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
}

type GetCockpitMetricsRequest struct {
	// ProjectID: ID of the Project the Cockpit belongs to.
	ProjectID string `json:"-"`
	// StartDate: desired time range's start date for the metrics.
	StartDate *time.Time `json:"-"`
	// EndDate: desired time range's end date for the metrics.
	EndDate *time.Time `json:"-"`
	// MetricName: name of the metric requested.
	MetricName *string `json:"-"`
}

type GetCockpitRequest struct {
	// ProjectID: ID of the Project the Cockpit belongs to.
	ProjectID string `json:"-"`
}

type GetTokenRequest struct {
	// TokenID: ID of the token.
	TokenID string `json:"-"`
}

type GrafanaUser struct {
	// ID: ID of the Grafana user.
	ID uint32 `json:"id"`
	// Login: username of the Grafana user.
	Login string `json:"login"`
	// Role: role assigned to the Grafana user.
	// Default value: unknown_role
	Role GrafanaUserRole `json:"role"`
	// Password: the Grafana user's password.
	Password *string `json:"password"`
}

type GrafanaUserRole string

type ListContactPointsRequest struct {
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: page size.
	PageSize *uint32 `json:"-"`
	// ProjectID: ID of the Project from which to list the contact points.
	ProjectID string `json:"-"`
}

type ListContactPointsResponse struct {
	// TotalCount: count of all contact points created.
	TotalCount uint32 `json:"total_count"`
	// ContactPoints: array of contact points.
	ContactPoints []*ContactPoint `json:"contact_points"`
	// HasAdditionalReceivers: specifies whether the contact point has other receivers than the default receiver.
	HasAdditionalReceivers bool `json:"has_additional_receivers"`
	// HasAdditionalContactPoints: specifies whether there are unmanaged contact points.
	HasAdditionalContactPoints bool `json:"has_additional_contact_points"`
}

type ListGrafanaUsersRequest struct {
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: page size.
	PageSize *uint32 `json:"-"`
	// OrderBy: default value: login_asc
	OrderBy ListGrafanaUsersRequestOrderBy `json:"-"`
	// ProjectID: ID of the Project.
	ProjectID string `json:"-"`
}

type ListGrafanaUsersRequestOrderBy string

type ListGrafanaUsersResponse struct {
	// TotalCount: count of all Grafana users.
	TotalCount uint32 `json:"total_count"`
	// GrafanaUsers: information on all Grafana users.
	GrafanaUsers []*GrafanaUser `json:"grafana_users"`
}

type ListPlansRequest struct {
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: page size.
	PageSize *uint32 `json:"-"`
	// OrderBy: default value: name_asc
	OrderBy ListPlansRequestOrderBy `json:"-"`
}

type ListPlansRequestOrderBy string

type ListPlansResponse struct {
	// TotalCount: count of all pricing plans.
	TotalCount uint64 `json:"total_count"`
	// Plans: information on plans.
	Plans []*Plan `json:"plans"`
}

type ListTokensRequest struct {
	// Page: page number.
	Page *int32 `json:"-"`
	// PageSize: page size.
	PageSize *uint32 `json:"-"`
	// OrderBy: default value: created_at_asc
	OrderBy ListTokensRequestOrderBy `json:"-"`
	// ProjectID: ID of the Project.
	ProjectID string `json:"-"`
}

type ListTokensRequestOrderBy string

type ListTokensResponse struct {
	// TotalCount: count of all tokens created.
	TotalCount uint32 `json:"total_count"`
	// Tokens: list of all tokens created.
	Tokens []*Token `json:"tokens"`
}

type Plan struct {
	// ID: ID of a given pricing plan.
	ID string `json:"id"`
	// Name: name of a given pricing plan.
	// Default value: unknown_name
	Name PlanName `json:"name"`
	// RetentionMetricsInterval: retention for metrics.
	RetentionMetricsInterval *scw.Duration `json:"retention_metrics_interval"`
	// RetentionLogsInterval: retention for logs.
	RetentionLogsInterval *scw.Duration `json:"retention_logs_interval"`
	// SampleIngestionPrice: ingestion price for 1 million samples in cents.
	SampleIngestionPrice uint32 `json:"sample_ingestion_price"`
	// LogsIngestionPrice: ingestion price for 1 GB of logs in cents.
	LogsIngestionPrice uint32 `json:"logs_ingestion_price"`
	// RetentionPrice: retention price in euros per month.
	RetentionPrice uint32 `json:"retention_price"`
}

type PlanName string

type ResetCockpitGrafanaRequest struct {
	// ProjectID: ID of the Project the Cockpit belongs to.
	ProjectID string `json:"project_id"`
}

type ResetGrafanaUserPasswordRequest struct {
	// GrafanaUserID: ID of the Grafana user.
	GrafanaUserID uint32 `json:"-"`
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
}

type SelectPlanRequest struct {
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
	// PlanID: ID of the pricing plan.
	PlanID string `json:"plan_id"`
}

type SelectPlanResponse struct {
}

type Token struct {
	// ID: ID of the token.
	ID string `json:"id"`
	// ProjectID: ID of the Project.
	ProjectID string `json:"project_id"`
	// Name: name of the token.
	Name string `json:"name"`
	// CreatedAt: date and time of the token's creation.
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: date and time of the token's last update.
	UpdatedAt *time.Time `json:"updated_at"`
	// Scopes: token's permissions.
	Scopes *TokenScopes `json:"scopes"`
	// SecretKey: token's secret key.
	SecretKey *string `json:"secret_key"`
}

type TokenScopes struct {
	// QueryMetrics: permission to fetch metrics.
	QueryMetrics bool `json:"query_metrics"`
	// WriteMetrics: permission to write metrics.
	WriteMetrics bool `json:"write_metrics"`
	// SetupMetricsRules: permission to setup metrics rules.
	SetupMetricsRules bool `json:"setup_metrics_rules"`
	// QueryLogs: permission to fetch logs.
	QueryLogs bool `json:"query_logs"`
	// WriteLogs: permission to write logs.
	WriteLogs bool `json:"write_logs"`
	// SetupLogsRules: permission to set up logs rules.
	SetupLogsRules bool `json:"setup_logs_rules"`
	// SetupAlerts: permission to set up alerts.
	SetupAlerts bool `json:"setup_alerts"`
	// QueryTraces: permission to fetch traces.
	QueryTraces bool `json:"query_traces"`
	// WriteTraces: permission to write traces.
	WriteTraces bool `json:"write_traces"`
}

type TriggerTestAlertRequest struct {
	ProjectID string `json:"project_id"`
}

type WaitForCockpitRequest struct {
	ProjectID     string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}