api

type APIError struct {
	StatusCode int              `json:"statusCode"` // StatusCode is the HTTP response status code returned by the API.
	Body       []byte           `json:"body"`       // Body is the HTTP payload returned by the API.
	Request    rest.RequestInfo `json:"request"`    // Request is information about the original request that led to this response error.
}

type ClientError struct {
	// Wrapped is the original error returned by the rest.Client.
	Wrapped error

	// Identifier is an optional string used to uniquely identify
	// the resource or entity involved in the failed operation.
	Identifier string

	// Operation is the HTTP method (e.g., GET, POST, PUT, DELETE) http/method.go
	// used in the request that caused the error.
	Operation string

	// Resource specifies the Dynatrace API resource involved in the request,
	// such as "segments", "documents", etc.
	Resource string

	// Reason provides a human-readable explanation of why the error occurred.
	Reason string
}

type ListResponse struct {
	Response
	Objects [][]byte `json:"-"`
}

type PagedListResponse []ListResponse

type Response struct {
	StatusCode int `json:"-"`
	Header     http.Header
	Data       []byte           `json:"-"`
	Request    rest.RequestInfo `json:"-"`
}

type RuntimeError struct {
	// Wrapped is the original error that triggered this runtime failure.
	// It contains the low-level error details.
	Wrapped error

	// Resource is the name of the resource involved in the failed operation.
	// This helps identify which part of the system or API the error relates to.
	Resource string

	// Reason explains why the runtime assumption failed or what condition was not met.
	// This is useful for understanding the nature of the failure.
	Reason string

	// Identifier optionally provides a specific ID or key related to the resource.
	// If set, it will be included in the error message for more precise context.
	Identifier string
}

type ValidationError struct {
	// Field is the name of the field that failed validation.
	Field string

	// Reason provides a human-readable explanation of why the validation failed.
	Reason string
}