base

type ApiResponse[T any] struct {
	Success            bool                 `json:"success" doc:"Whether the request was successful"`
	Data               T                    `json:"data" doc:"Response data"`
	FailedEnvironments []EnvironmentFailure `json:"failedEnvironments,omitempty" doc:"Environments whose results are missing from a multi-environment response"`
}

type EnvironmentFailure struct {
	Environment EnvironmentRef `json:"environment" doc:"Environment that failed"`
	Message     string         `json:"message" doc:"Why the environment's results are missing"`
}

type EnvironmentRef struct {
	ID   string `json:"id" doc:"Environment ID"`
	Name string `json:"name" doc:"Environment display name"`
}

type EnvironmentTag struct {
	EnvironmentID   string `json:"environmentId,omitempty" doc:"Environment the row came from in a multi-environment list"`
	EnvironmentName string `json:"environmentName,omitempty" doc:"Display name of the environment the row came from"`
}

type ErrorResponse struct {
	Error string `json:"error" doc:"Error message describing what went wrong"`
}

type FieldError struct {
	Field string
	Err   error
}

type JsonObject map[string]any

type MessageResponse struct {
	Message    string  `json:"message" doc:"Response message"`
	ActivityID *string `json:"activityId,omitempty" doc:"Background activity ID tracking this action"`
}

type Paginated[T any] struct {
	Success            bool                 `json:"success" doc:"Whether the request was successful"`
	Data               []T                  `json:"data" doc:"Array of items for the current page"`
	Pagination         PaginationResponse   `json:"pagination" doc:"Pagination metadata"`
	FailedEnvironments []EnvironmentFailure `json:"failedEnvironments,omitempty" doc:"Environments whose results are missing from a multi-environment response"`
}

type PaginatedWithCounts[T, C any] struct {
	Success            bool                 `json:"success" doc:"Whether the request was successful"`
	Data               []T                  `json:"data" doc:"Array of items for the current page"`
	Counts             C                    `json:"counts" doc:"Aggregate counts for the filtered collection"`
	Pagination         PaginationResponse   `json:"pagination" doc:"Pagination metadata"`
	FailedEnvironments []EnvironmentFailure `json:"failedEnvironments,omitempty" doc:"Environments whose results are missing from a multi-environment response"`
}

type PaginatedWithWarnings[T any] struct {
	Success    bool               `json:"success"`
	Data       []T                `json:"data"`
	Pagination PaginationResponse `json:"pagination"`
	Warnings   []string           `json:"warnings,omitempty"`
}

type PaginationResponse struct {
	TotalPages      int64 `json:"totalPages" doc:"Total number of pages"`
	TotalItems      int64 `json:"totalItems" doc:"Total number of items in the current filtered set"`
	CurrentPage     int   `json:"currentPage" doc:"Current page number (1-indexed)"`
	ItemsPerPage    int   `json:"itemsPerPage" doc:"Number of items per page"`
	GrandTotalItems int64 `json:"grandTotalItems,omitempty" doc:"Total number of items without filters"`
}