types

type DiagnosticSeverityString string

type Diagnostics hcl.Diagnostics

type FriendlyDiagnostic struct {
	Severity DiagnosticSeverityString `json:"severity"`
	Summary  string                   `json:"summary"`
	Detail   string                   `json:"detail"`
}

type HCLString struct {
	Value cty.Value

	// ValueDiags are any diagnostics that occurred
	// while evaluating the value
	ValueDiags hcl.Diagnostics
	// ValueExp is the underlying source expression
	ValueExpr hcl.Expression
	// Source is the literal hcl text that was parsed.
	// This is a best effort, it may not be available.
	Source *string
}

type NullHCLString struct {
	Value string `json:"value"`
	Valid bool   `json:"valid"`
}

type Parameter struct {
	ParameterData
	// Value is not immediately cast into a string.
	// Value is not required at template import, so defer
	// casting to a string until it is absolutely necessary.
	Value HCLString `json:"value"`

	// Diagnostics is used to store any errors that occur during parsing
	// of the parameter.
	Diagnostics Diagnostics `json:"diagnostics"`
}

type ParameterData struct {
	Name         string                     `json:"name"`
	DisplayName  string                     `json:"display_name"`
	Description  string                     `json:"description"`
	Type         ParameterType              `json:"type"`
	FormType     provider.ParameterFormType `json:"form_type"`
	Styling      any                        `json:"styling"`
	Mutable      bool                       `json:"mutable"`
	DefaultValue HCLString                  `json:"default_value"`
	Icon         string                     `json:"icon"`
	Options      []*ParameterOption         `json:"options"`
	Validations  []*ParameterValidation     `json:"validations"`
	Required     bool                       `json:"required"`
	// legacy_variable_name was removed (= 14)
	Order     int64 `json:"order"`
	Ephemeral bool  `json:"ephemeral"`

	// Unexported fields, not always available.
	Source *terraform.Block `json:"-"`
}

type ParameterOption struct {
	Name        string    `json:"name"`
	Description string    `json:"description"`
	Value       HCLString `json:"value"`
	Icon        string    `json:"icon"`
}

type ParameterType string

type ParameterValidation struct {
	Error string `json:"validation_error"`

	// All validation attributes are optional.
	Regex     *string `json:"validation_regex"`
	Min       *int64  `json:"validation_min"`
	Max       *int64  `json:"validation_max"`
	Monotonic *string `json:"validation_monotonic"`
	Invalid   *bool   `json:"validation_invalid"`
}

type Tag struct {
	Key   HCLString
	Value HCLString
}

type TagBlock struct {
	Tags  Tags
	Block *terraform.Block
}

type TagBlocks []TagBlock

type Tags []Tag

type WorkspaceOwner struct {
	ID           string `json:"id" cty:"id"`
	Name         string `json:"name" cty:"name"`
	FullName     string `json:"full_name" cty:"full_name"`
	Email        string `json:"email" cty:"email"`
	SSHPublicKey string `json:"ssh_public_key" cty:"ssh_public_key"`
	// SSHPrivateKey is intentionally omitted for now, due to the security risk
	// that exposing it poses.
	// SSHPrivateKey string `json:"ssh_private_key" cty:"ssh_private_key"`
	Groups []string `json:"groups" cty:"groups"`
	// SessionToken is intentionally omitted for now, due to the security risk
	// that exposing it poses.
	// SessionToken string `json:"session_token" cty:"session_token"`
	// OIDCAccessToken is intentionally omitted for now, due to the security risk
	// that exposing it poses.
	// OIDCAccessToken string `json:"oidc_access_token" cty:"oidc_access_token"`
	LoginType string                   `json:"login_type" cty:"login_type"`
	RBACRoles []WorkspaceOwnerRBACRole `json:"rbac_roles" cty:"rbac_roles"`
}

type WorkspaceOwnerRBACRole struct {
	Name  string `json:"name" cty:"name"`
	OrgID string `json:"org_id" cty:"org_id"`
}