compliancebenchmarks

type ApiError struct {
	Errors []ApiErrorErrorsItem `json:"errors"`
	// HTTP status of the response.
	HttpStatus int `json:"httpStatus"`
	// Unique identifier for the request, useful for tracing and debugging.
	TraceID string `json:"traceId"`
}

type ApiErrorErrorsItem struct {
	// Error-specific code for troubleshooting.
	Code string `json:"code"`
	// A detailed error message.
	Description string `json:"description"`
	// The field that caused the error.
	Field string `json:"field"`
}

type BaselineInfo struct {
	BaselineID  string `json:"baselineId"`
	Description string `json:"description"`
	ID          string `json:"id"`
	RuleCount   int    `json:"ruleCount"`
	Title       string `json:"title"`
}

type BaselinesResponse struct {
	Baselines []BaselineInfo `json:"baselines"`
}

type BenchmarkRequestV2 struct {
	// A detailed description of the benchmark.
	Description *string `json:"description,omitempty"`
	// The enforcement mode for this benchmark.
	// Allowed values: see the BenchmarkRequestV2EnforcementMode constants.
	EnforcementMode string `json:"enforcementMode"`
	// The rules that make up this benchmark.
	Rules []RuleRequest `json:"rules"`
	// The selected OS versions for this benchmark, default is all available baseline OS versions.
	SelectedOsVersions *[]OsVersion `json:"selectedOsVersions,omitempty"`
	// The identifier of the source baseline from which this benchmark is derived.
	SourceBaselineID string `json:"sourceBaselineId"`
	// The target device group IDs to which a benchmark is deployed.
	Target TargetV2 `json:"target"`
	// A short, descriptive name for the benchmark.
	Title string `json:"title"`
}

type BenchmarkRequestV2EnforcementMode = string

type BenchmarkResponseV2 struct {
	// Available OS versions that this baseline supports.
	AvailableOsVersions []OsVersion `json:"availableOsVersions"`
	BaselineID          string      `json:"baselineId"`
	BenchmarkID         string      `json:"benchmarkId"`
	CanSwitchToEnforce  bool        `json:"canSwitchToEnforce"`
	Deleted             bool        `json:"deleted"`
	Description         string      `json:"description"`
	// Allowed values: see the BenchmarkResponseV2EnforcementMode constants.
	EnforcementMode string     `json:"enforcementMode"`
	LastUpdatedAt   time.Time  `json:"lastUpdatedAt"`
	Rules           []RuleInfo `json:"rules"`
	// The user-selected OS versions with full metadata.
	SelectedOsVersions []OsVersion `json:"selectedOsVersions"`
	Sources            []Source    `json:"sources"`
	// The target device group IDs to which a benchmark is deployed.
	Target          *TargetV2 `json:"target,omitempty"`
	TenantID        string    `json:"tenantId"`
	Title           string    `json:"title"`
	UpdateAvailable bool      `json:"updateAvailable"`
}

type BenchmarkResponseV2EnforcementMode = string

type BenchmarkRuleDevicesResponse struct {
	Results    []DeviceRuleResult `json:"results"`
	TotalCount int                `json:"totalCount"`
}

type BenchmarkRulesStatsResponse struct {
	Results    []RuleResult `json:"results"`
	TotalCount int          `json:"totalCount"`
}

type BenchmarkV2 struct {
	Description string `json:"description"`
	ID          string `json:"id"`
	Modified    bool   `json:"modified"`
	// Allowed values: see the BenchmarkV2SyncState constants.
	SyncState string `json:"syncState"`
	// The target device group IDs to which a benchmark is deployed.
	Target          *TargetV2 `json:"target,omitempty"`
	Title           string    `json:"title"`
	UpdateAvailable bool      `json:"updateAvailable"`
}

type BenchmarkV2SyncState = string

type BenchmarksResponseV2 struct {
	Benchmarks []BenchmarkV2 `json:"benchmarks"`
}

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

type CompliancePercentage struct {
	CompliancePercentage float32 `json:"compliancePercentage"`
}

type DeviceRuleResult struct {
	// Device Platform ID.
	DeviceID   string          `json:"deviceId"`
	DeviceName *string         `json:"deviceName,omitempty"`
	State      RuleResultState `json:"state"`
}

type ODVRecommendation struct {
	Hint  string `json:"hint"`
	Value string `json:"value"`
}

type ODVRequest struct {
	Value string `json:"value"`
}

type OrganizationDefinedValue struct {
	Hint        string `json:"hint"`
	Placeholder string `json:"placeholder"`
	// Allowed values: see the OrganizationDefinedValueType constants.
	Type string `json:"type"`
	// Validation constraints for an organization-defined value (ODV), specifying allowed range, enum
	// values, or regex pattern.
	Validation *ValidationConstraints `json:"validation,omitempty"`
	Value      string                 `json:"value"`
}

type OrganizationDefinedValueType = string

type OsInfo struct {
	// Allowed values: see the OsInfoManagementType constants.
	ManagementType string `json:"managementType"`
	// Allowed values: see the OsInfoOsType constants.
	OsType    string `json:"osType"`
	OsVersion int    `json:"osVersion"`
}

type OsInfoManagementType = string

type OsInfoOsType = string

type OsSpecificRuleInfo struct {
	Description string `json:"description"`
	// Recommended value and hint for an organization-defined value (ODV) field.
	ODV   *ODVRecommendation `json:"odv,omitempty"`
	Title string             `json:"title"`
}

type OsVersion struct {
	// Operating system type.
	// Allowed values: see the OsVersionOsType constants.
	OsType string `json:"osType"`
	// Operating system version number.
	OsVersion int `json:"osVersion"`
}

type OsVersionOsType = string

type RuleInfo struct {
	Description string `json:"description"`
	Enabled     bool   `json:"enabled"`
	ID          string `json:"id"`
	// An organization-defined value (ODV) that customizes a parameterized compliance rule.
	ODV                *OrganizationDefinedValue     `json:"odv,omitempty"`
	OsSpecificDefaults map[string]OsSpecificRuleInfo `json:"osSpecificDefaults"`
	References         *[]string                     `json:"references,omitempty"`
	Reportable         bool                          `json:"reportable"`
	// Dependency and conflict relationships between compliance rules.
	RuleRelation *RuleRelation `json:"ruleRelation,omitempty"`
	SectionName  string        `json:"sectionName"`
	SmartCard    bool          `json:"smartCard"`
	SupportedOs  []OsInfo      `json:"supportedOs"`
	Title        string        `json:"title"`
}

type RuleRelation struct {
	ConflictsWith   []string `json:"conflictsWith"`
	DefaultDisabled bool     `json:"defaultDisabled"`
	DependsOn       []string `json:"dependsOn"`
}

type RuleRequest struct {
	Enabled bool   `json:"enabled"`
	ID      string `json:"id"`
	// User-supplied value for an organization-defined value (ODV) rule parameter.
	ODV *ODVRequest `json:"odv,omitempty"`
}

type RuleResult struct {
	Discussion      string  `json:"discussion"`
	Failed          int     `json:"failed"`
	NumberOfDevices int     `json:"numberOfDevices"`
	PassPercentage  float32 `json:"passPercentage"`
	Passed          int     `json:"passed"`
	RuleID          string  `json:"ruleId"`
	// Rule number in the benchmark, if applicable. E.g. CIS numbers like '2.5.1.1'.
	RuleNumber string `json:"ruleNumber"`
	RuleTitle  string `json:"ruleTitle"`
	Unknown    int    `json:"unknown"`
}

type RuleResultState = string

type Source struct {
	Branch   string `json:"branch"`
	Revision string `json:"revision"`
}

type SourcedRules struct {
	AvailableOsVersions []OsVersion `json:"availableOsVersions"`
	Rules               []RuleInfo  `json:"rules"`
	Sources             []Source    `json:"sources"`
}

type TargetV2 struct {
	DeviceGroups []string `json:"deviceGroups"`
}

type ValidationConstraints struct {
	EnumValues []string `json:"enumValues"`
	Max        int      `json:"max"`
	Min        int      `json:"min"`
	Regex      string   `json:"regex"`
}