types

type Agent struct {
	ID       uint64 `json:"agentID,string"`
	Handle   string `json:"handle"`
	Status   string `json:"status"`
	Revision int    `json:"revision"`

	Labels map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	Meta       AgentMeta       `json:"meta"`
	Behavior   AgentBehavior   `json:"behavior"`
	Execution  AgentExecution  `json:"execution"`
	Access     AgentAccess     `json:"access"`
	Invocation AgentInvocation `json:"invocation"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
}

type AgentAccess struct {
	Context   AgentAccessContext    `json:"context"`
	Tools     []AgentAccessTool     `json:"tools,omitempty"`
	TAQs      []AgentAccessTAQ      `json:"taqs,omitempty"`
	Workflows []AgentAccessWorkflow `json:"workflows,omitempty"`
}

type AgentAccessAllow struct {
	NamespaceID uint64            `json:"namespaceID,string"`
	ModuleIDs   AgentAccessIDList `json:"moduleIDs"`
}

type AgentAccessContext struct {
	Namespace string         `json:"namespace,omitempty"`
	Module    string         `json:"module,omitempty"`
	Defaults  map[string]any `json:"defaults,omitempty"`
}

type AgentAccessIDList []uint64

type AgentAccessTAQ struct {
	ID          uint64            `json:"id,string"`
	Description string            `json:"description,omitempty"`
	Params      map[string]string `json:"params,omitempty"`
}

type AgentAccessTool struct {
	Name        string                 `json:"name"`
	Description string                 `json:"description"`
	Allow       []AgentAccessAllow     `json:"allow"`
	Context     AgentAccessToolContext `json:"context,omitempty"`
}

type AgentAccessToolContext struct {
	Defaults  map[string]any `json:"defaults,omitempty"`
	Overrides map[string]any `json:"overrides,omitempty"`
}

type AgentAccessWorkflow struct {
	ID          uint64 `json:"id,string"`
	Description string `json:"description,omitempty"`
}

type AgentBehavior struct {
	SystemPrompt        string              `json:"systemPrompt,omitempty"`
	Guardrails          []string            `json:"guardrails,omitempty"`
	InjectSystemContext bool                `json:"injectSystemContext"`
	KnowledgeBases      KnowledgeBaseIDList `json:"knowledgeBases,omitempty"`
	TreatyCLEnabled     *bool               `json:"treatyCLEnabled"`          // nil = enabled by default
	TreatyCLTemperature int                 `json:"tclTemperature,omitempty"` // 1–10, controls citation verbosity
	TreatyCLArticles    []string            `json:"tclArticles,omitempty"`    // selected article IDs
}

type AgentExecution struct {
	Model  AgentExecutionModel  `json:"model"`
	Limits AgentExecutionLimits `json:"limits"`
}

type AgentExecutionLimits struct {
	MaxIterations  int     `json:"maxIterations,omitempty"`
	Timeout        string  `json:"timeout"`
	SoftLimitRatio float64 `json:"softLimitRatio,omitempty"`
	ContextWindow  int     `json:"contextWindow"`
	OutputTokens   int     `json:"outputTokens"`
}

type AgentExecutionModel struct {
	LLMProviderID uint64   `json:"llmProviderID,string,omitempty"`
	Model         string   `json:"model,omitempty"`
	Temperature   *float64 `json:"temperature,omitempty"`
}

type AgentFilter struct {
	AgentID []string `json:"agentID"`
	Handle  string   `json:"handle"`
	Status  string   `json:"status"`
	Query   string   `json:"query"`

	Deleted filter.State `json:"deleted"`

	LabeledIDs []uint64                         `json:"-"`
	Labels     map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Agent) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type AgentInvocation struct {
	User   AgentInvocationUser   `json:"user"`
	System AgentInvocationSystem `json:"system"`
}

type AgentInvocationSystem struct {
	Enabled        bool            `json:"enabled"`
	ServiceAccount uint64          `json:"serviceAccount,string,omitempty"`
	InputSchema    json.RawMessage `json:"inputSchema,omitempty"`
	OutputFormat   string          `json:"outputFormat,omitempty"`
}

type AgentInvocationUser struct {
	Enabled bool `json:"enabled"`
}

type AgentMeta struct {
	Short        string   `json:"short"`
	Description  string   `json:"description,omitempty"`
	SidebarRoles []string `json:"sidebarRoles,omitempty"`
}

type AgentSet []*Agent

type AiConversation struct {
	ID         uint64                 `json:"aiConversationID,string"`
	AgentID    uint64                 `json:"agentID,string"`
	Messages   AiConversationMessages `json:"messages"`
	TokenCount int                    `json:"tokenCount"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
}

type AiConversationFilter struct {
	AiConversationID []uint64     `json:"aiConversationID"`
	AgentID          uint64       `json:"agentID,string"`
	Deleted          filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*AiConversation) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type AiConversationMessage struct {
	Role        string                     `json:"role"`
	Content     string                     `json:"content"`
	Operator    string                     `json:"operator,omitempty"`
	ToolCalls   []AiConversationToolCall   `json:"toolCalls,omitempty"`
	ToolResults []AiConversationToolResult `json:"toolResults,omitempty"`
}

type AiConversationMessages []AiConversationMessage

type AiConversationSet []*AiConversation

type AiConversationToolCall struct {
	CallID string `json:"callID"`
	Name   string `json:"name"`
	Data   string `json:"data"`
}

type AiConversationToolResult struct {
	CallID string `json:"callID"`
	Data   string `json:"data"`
	Error  string `json:"error,omitempty"`
}

type ApigwFilter struct {
	ID      uint64            `json:"filterID,string"`
	Route   uint64            `json:"routeID,string"`
	Weight  uint64            `json:"weight,string"`
	Ref     string            `json:"ref,omitempty"`
	Kind    string            `json:"kind,omitempty"`
	Enabled bool              `json:"enabled,omitempty"`
	Params  ApigwFilterParams `json:"params"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string" `
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty" `
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty" `
}

type ApigwFilterFilter struct {
	ApigwFilterID []string `json:"apigwFilterID"`
	RouteID       uint64   `json:"routeID,string"`

	Deleted  filter.State `json:"deleted"`
	Disabled filter.State `json:"disabled"`

	Kind string `json:"kind"`
	Ref  string `json:"ref"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*ApigwFilter) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type ApigwFilterParams map[string]interface{}

type ApigwFilterSet []*ApigwFilter

type ApigwProfilerAggregation struct {
	Path  string  `json:"path"`
	Count uint64  `json:"count"`
	Smin  int64   `json:"size_min"`
	Smax  int64   `json:"size_max"`
	Savg  float64 `json:"size_avg"`
	Tmin  float64 `json:"time_min"`
	Tmax  float64 `json:"time_max"`
	Tavg  float64 `json:"time_avg"`
}

type ApigwProfilerAggregationSet []*ApigwProfilerAggregation

type ApigwProfilerFilter struct {
	Hit    string `json:"hit,omitempty"`
	Path   string `json:"path,omitempty"`
	Before string `json:"before,omitempty"`
	Next   string `json:"next,omitempty"`

	filter.Sorting
	filter.Paging
}

type ApigwProfilerHit struct {
	ID string `json:"ID"`

	Body    []byte    `json:"body"`
	Request h.Request `json:"request"`
	Route   uint64    `json:"route,string"`
	Status  int       `json:"http_status_code,string"`

	Ts *time.Time     `json:"time_start"`
	Tf *time.Time     `json:"time_finish"`
	D  *time.Duration `json:"-"`
	Dr float64        `json:"time_duration"`
}

type ApigwProfilerHitSet []*ApigwProfilerHit

type ApigwRoute struct {
	ID       uint64         `json:"routeID,string"`
	Endpoint string         `json:"endpoint"`
	Method   string         `json:"method"`
	Enabled  bool           `json:"enabled"`
	Group    uint64         `json:"group,string"`
	Meta     ApigwRouteMeta `json:"meta"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string" `
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty" `
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty" `
}

type ApigwRouteFilter struct {
	ApigwRouteID []string `json:"apigwRouteID"`
	Route        string   `json:"route"`
	Endpoint     string   `json:"endpoint"`
	Method       string   `json:"method"`

	Deleted  filter.State `json:"deleted"`
	Disabled filter.State `json:"disabled"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*ApigwRoute) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type ApigwRouteMeta struct {
	Debug  bool                             `json:"debug"`
	Async  bool                             `json:"async"`
	Desc   string                           `json:"description"`
	Labels map[string]labelTypes.LabelValue `json:"labels,omitempty"`
}

type ApigwRouteSet []*ApigwRoute

type ApigwSettings struct {
	Enabled bool `kv:"enabled" json:"enabled"`

	Profiler struct {
		Enabled bool `kv:"enabled" json:"enabled"`
		Global  bool `kv:"global" json:"global"`
	} `kv:"profiler" json:"profiler"`

	Proxy struct {
		FollowRedirects bool          `kv:"follow-redirects" json:"follow-redirects"`
		OutboundTimeout time.Duration `kv:"outbound-timeout" json:"outbound-timeout"`
	} `kv:"proxy" json:"proxy"`
}

type AppSettings struct {
	Privacy struct {
		Mask struct {
			// Enable masking of user's email (value replaced with ######)
			Email bool

			// Enable masking of user's name (value replaced with ######)
			Name bool
		}
	} `json:"-"`

	General struct {
		Mail struct {
			Logo   string
			Header string `kv:"header.en"`
			Footer string `kv:"footer.en"`
		}
	} `json:"-"`

	SMTP struct {
		Servers []SmtpServers `json:"-" kv:"servers,final"`
	} `json:"-" kv:"smtp"`

	Auth struct {
		Internal struct {
			// Is internal authentication (username + password) enabled
			Enabled bool `json:"-"`

			Signup struct {
				// Can users register
				Enabled bool

				// Users must confirm their emails when signing-up
				EmailConfirmationRequired bool `kv:"email-confirmation-required"`
			} `json:"-"`

			// Can users reset their passwords
			PasswordReset struct{ Enabled bool } `json:"-" kv:"password-reset"`

			// When enabled, users added via CLI will receive an email with a link to reset their password.
			SendUserInviteEmail struct {
				Enabled bool
				Expires uint
			} `kv:"send-user-invite-email" json:"sendUserInviteEmail"`

			// PasswordCreate setting for create password for user via generated link with token
			// If user has no password then link redirects to create password page
			// Otherwise it redirects to profile page of that user
			// link can be generated through useradd cli command with `make-password-link` flag
			PasswordCreate struct {
				Enabled bool
				Expires uint
			} `json:"-" kv:"password-create"`

			// Splits credentials check into 2 parts
			// If user has password credentials it offers him to enter the password
			// Otherwise we offer the user to choose among the enabled external providers
			// If only one ext. provider is enabled, user is automatically redirected there
			SplitCredentialsCheck bool `json:"-" kv:"split-credentials-check"`

			PasswordConstraints PasswordConstraints `kv:"password-constraints" json:"passwordConstraints"`

			ProfileAvatar struct{ Enabled bool } `kv:"profile-avatar" json:"profile-avatar"`
		} `json:"internal"`

		External struct {
			// Is external authentication
			Enabled bool `json:"enabled"`

			// Saml
			Saml struct {
				Enabled bool

				// IdP name used on the login form
				Name string `kv:"name"`

				// SAML certificate
				Cert string `kv:"cert"`

				// SAML certificate private key
				Key string `kv:"key"`

				// Sign AuthNRequest and assertion
				SignRequests bool `kv:"sign-requests"`

				// Signature method for signing
				SignMethod string `kv:"sign-method"`

				// Post or redirect binding
				Binding string `kv:"binding"`

				// Identity provider settings
				IDP struct {
					URL string `kv:"url"`

					// identifier payload from idp
					IdentName       string `kv:"ident-name"`
					IdentHandle     string `kv:"ident-handle"`
					IdentIdentifier string `kv:"ident-identifier"`
				} `kv:"idp"`

				Security ExternalAuthProviderSecurity `json:"-" kv:"security,final"`
			} `json:"-"`

			// all external providers we know
			Providers ExternalAuthProviderSet `json:"providers"`
		} `json:"external"`

		AutoLogOut struct {
			Enabled bool `kv:"enabled" json:"enabled"`
			Timeout int  `kv:"timeout" json:"timeout"`
		} `json:"autoLogout" kv:"auto-logout"`

		MultiFactor struct {
			EmailOTP struct {
				// Can users use email for MFA
				Enabled bool

				// Is MFA with email enforced?
				Enforced bool

				Expires uint
			} `kv:"email-otp"`

			TOTP struct {
				// Can users use TOTP for MFA
				Enabled bool

				// Is MFA with TOTP enforced?
				Enforced bool

				// TOTP issuer, defaults to "Human"
				Issuer string
			} `kv:"totp"`
		} `json:"-" kv:"multi-factor"`

		Mail struct {
			FromAddress string `kv:"from-address"`
			FromName    string `kv:"from-name"`
		} `json:"-"`

		// Auth Background Image settings
		UI struct {
			BackgroundImageSrc string `kv:"background-image-src" json:"backgroundImageSrc"`
			Styles             string `kv:"styles" json:"styles"`
		} `kv:"ui" json:"ui"`
	} `json:"auth"`

	Compose struct {
		// Compose UI settings
		UI struct {
			// Sidebar specific settings
			Sidebar struct {
				// Hide namespace list
				HideNamespaceList bool `json:"hideNamespaceList"`

				// Hide namespace link at the end of the list
				HideNamespaceListLink bool `json:"hideNamespaceListLink"`
			} `kv:"sidebar,final" json:"sidebar"`

			// Record toolbar specific settings
			RecordToolbar struct {
				HideNew    bool `json:"hideNew"`
				HideEdit   bool `json:"hideEdit"`
				HideSubmit bool `json:"hideSubmit"`
				HideDelete bool `json:"hideDelete"`
				HideClone  bool `json:"hideClone"`
				HideBack   bool `json:"hideBack"`
			} `kv:"record-toolbar,final" json:"record-toolbar"`
		} `kv:"ui" json:"ui"`

		// Record related settings
		Record struct {
			// @todo implementation
			Attachments struct {
				// What is max size (in MB, so: MaxSize x 2^20)
				MaxSize uint `kv:"max-size"`

				// List of mime-types we support,
				Mimetypes []string
			}
		}

		// Page related settings
		Page struct {
			// @todo implementation
			Attachments struct {
				// What is max size (in MB, so: MaxSize x 2^20)
				MaxSize uint `kv:"max-size"`

				// List of mime-types we support,
				Mimetypes []string
			}
		}

		// Icon related settings
		Icon struct {
			// @todo implementation
			Attachments struct {
				// What is max size (in MB, so: MaxSize x 2^20)
				MaxSize uint `kv:"max-size"`

				// List of mime-types we support,
				Mimetypes []string
			}
		}
	} `kv:"compose" json:"compose"`

	// Federation settings
	Federation struct {
		// This only holds the value of FEDERATION_ENABLED for now
		//
		Enabled bool `kv:"-" json:"enabled"`
	} `kv:"federation" json:"federation"`

	// Integration gateway settings
	Apigw ApigwSettings `kv:"apigw" json:"apigw"`

	CodeSnippets []struct{ CodeSnippet } `kv:"code-snippets" json:"codeSnippets"`

	// UserInterface settings
	UI struct {
		MainLogo string `kv:"main-logo" json:"mainLogo"`
		IconLogo string `kv:"icon-logo" json:"iconLogo"`

		Sidebar struct {
			// General sidebar settings
			Disabled bool `json:"disabled"`
		} `kv:"sidebar,final" json:"sidebar"`

		Studio struct {
			Themes    []struct{ Theme } `kv:"themes" json:"themes"`
			CustomCSS []struct{ Theme } `kv:"custom-css" json:"customCSS"`
		} `kv:"studio" json:"studio"`

		Topbar struct {
			HideAppSelector        bool `json:"hideAppSelector"`
			HideHelp               bool `json:"hideHelp"`
			HideForumLink          bool `json:"hideForumLink"`
			HideDocumentationLink  bool `json:"hideDocumentationLink"`
			HideFeedbackLink       bool `json:"hideFeedbackLink"`
			HideProfile            bool `json:"hideProfile"`
			HideChangePasswordLink bool `json:"hideChangePasswordLink"`
			HideProfileLink        bool `json:"hideProfileLink"`
			HideThemeSelector      bool `json:"hideThemeSelector"`
			HideNotifications      bool `json:"hideNotifications"`
			ShowDrafts             bool `json:"showDrafts"`

			HelpLinks []struct {
				Handle string `json:"handle"`
				URL    string `json:"url"`
				NewTab bool   `json:"newTab"`
			} `json:"helpLinks"`

			ProfileLinks []struct {
				Handle string `json:"handle"`
				URL    string `json:"url"`
				NewTab bool   `json:"newTab"`
			} `json:"profileLinks"`

			PageButtons []struct {
				Label       string `json:"label"`
				URL         string `json:"url"`
				URLMatch    string `json:"urlMatch"`
				NewTab      bool   `json:"newTab"`
				Description string `json:"description"`
			} `json:"pageButtons"`
		} `kv:"topbar,final" json:"topbar"`

		Charts struct {
			ColorSchemes []struct {
				ID     string   `json:"id"`
				Name   string   `json:"name"`
				Colors []string `json:"colors"`
			} `kv:"colorSchemes" json:"colorSchemes"`
		} `kv:"charts" json:"charts"`

		Location struct {
			GeoSearchProvider string `json:"geoSearchProvider"`
			GeoSearchApiKey   string `json:"geoSearchApiKey"`
		} `kv:"location,final" json:"location"`
	} `kv:"ui" json:"ui"`

	ResourceTranslations struct {

		// This is always a subset of all languages available
		// in Human instance (LOCALE_LANGUAGES)
		//
		// Note: later, we will enable this to contain languages
		//       that are not part of LOCALE_LANGUAGES
		//
		// 1st language in the set is also a default one
		//
		// IsEmpty slice defaults to LOCALE_LANGUAGES
		Languages []string `kv:"languages" json:"languages"`
	} `kv:"resource-translations" json:"resourceTranslations"`

	Discovery struct {
		// Enable indexing
		Enabled bool `kv:"enabled" json:"enabled"`

		SystemUsers struct {
			// Enable indexing of users
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"system-users" json:"system-users"`

		SystemApplications struct {
			// Enable indexing of applications
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"system-applications" json:"system-applications"`

		SystemRoles struct {
			// Enable indexing of roles
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"system-roles" json:"system-roles"`

		SystemTemplates struct {
			// Enable indexing of templates
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"system-templates" json:"system-templates"`

		AutomationWorkflows struct {
			// Enable indexing of workflows
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"automation-workflows" json:"automation-workflows"`

		ComposeNamespaces struct {
			// Enable indexing of compose namespaces
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"compose-namespaces" json:"compose-namespaces"`

		ComposeCharts struct {
			// Enable indexing of compose charts
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"compose-charts" json:"compose-charts"`

		ComposePages struct {
			// Enable indexing of compose pages
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"compose-pages" json:"compose-pages"`

		ComposeModules struct {
			// Enable indexing of compose modules
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"compose-modules" json:"compose-modules"`

		ComposeRecords struct {
			// Enable indexing of compose records
			Enabled bool `kv:"enabled" json:"enabled"`
		} `kv:"compose-records" json:"compose-records"`
	} `kv:"discovery" json:"discovery"`
}

type Application struct {
	ID      uint64 `json:"applicationID,string"`
	Name    string `json:"name"`
	OwnerID uint64 `json:"ownerID"`
	Enabled bool   `json:"enabled"`
	Weight  int    `json:"weight"`

	Unify *ApplicationUnify `json:"unify,omitempty"`

	Labels map[string]labelTypes.LabelValue `json:"labels,omitempty"`
	Flags  []string                         `json:"flags,omitempty"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type ApplicationFilter struct {
	ApplicationID []string `json:"applicationID"`
	Name          string   `json:"name"`
	Query         string   `json:"query"`

	LabeledIDs []uint64                         `json:"-"`
	Labels     map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	FlaggedIDs []uint64 `json:"-"`
	Flags      []string `json:"flags,omitempty"`
	IncFlags   uint     `json:"-"`

	Deleted filter.State `json:"deleted"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Application) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type ApplicationMetrics struct {
	Total   uint `json:"total"`
	Deleted uint `json:"deleted"`
	Valid   uint `json:"valid"`
}

type ApplicationSet []*Application

type ApplicationUnify struct {
	Name   string `json:"name,omitempty"`
	Listed bool   `json:"listed"`
	Url    string `json:"url"`
	Config string `json:"config"`

	// Temporary icon & logo URLs
	// @todo rework this when we rework attachment management
	Icon   string `json:"icon,omitempty"`
	IconID uint64 `json:"iconID,string"`
	Logo   string `json:"logo,omitempty"`
	LogoID uint64 `json:"logoID,string"`
}

type Attachment struct {
	ID         uint64         `json:"attachmentID,string"`
	OwnerID    uint64         `json:"ownerID,string"`
	Kind       string         `json:"-"`
	Url        string         `json:"url,omitempty"`
	PreviewUrl string         `json:"previewUrl,omitempty"`
	Name       string         `json:"name,omitempty"`
	Meta       AttachmentMeta `json:"meta"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type AttachmentFileMeta struct {
	Size      int64                `json:"size"`
	Extension string               `json:"ext"`
	Mimetype  string               `json:"mimetype"`
	Image     *AttachmentImageMeta `json:"image,omitempty"`
}

type AttachmentFilter struct {
	Kind   string `json:"kind,omitempty"`
	Filter string `json:"filter"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*Attachment) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type AttachmentImageMeta struct {
	Width           int    `json:"width,omitempty"`
	Height          int    `json:"height,omitempty"`
	Animated        bool   `json:"animated"`
	Initial         string `json:"initial,omitempty"`
	InitialColor    string `json:"initial-color,omitempty"`
	BackgroundColor string `json:"background-color,omitempty"`
}

type AttachmentMeta struct {
	Original AttachmentFileMeta  `json:"original"`
	Preview  *AttachmentFileMeta `json:"preview,omitempty"`
	Labels   map[string]string   `json:"labels,omitempty"`
}

type AttachmentSet []*Attachment

type AuthClient struct {
	ID uint64 `json:"authClientID,string"`

	// Client's handle
	Handle string `json:"handle"`

	// Client's meta data, see comments on AuthClientMeta
	Meta *AuthClientMeta `json:"meta,omitempty"`

	// Client secret
	Secret string `json:"secret,omitempty"`

	Scope string `json:"scope"`

	// valid grant for this client (only one)
	//  - authorization_code
	//  - client_credentials
	ValidGrant string `json:"validGrant"`

	// Valid redirection URIs
	RedirectURI string `json:"redirectURI"`

	// Users will not be prompted to confirm the client after login
	Trusted bool `json:"trusted"`

	// Can client be used for authentication
	Enabled bool `json:"enabled"`

	// Is client valid yet?
	ValidFrom *time.Time `json:"validFrom,omitempty"`

	// Is client still valid
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`

	// Role-specific settings, see comments on AuthClientSecurity
	Security *AuthClientSecurity `json:"security"`

	// Auth client labels
	Labels map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	OwnedBy   uint64     `json:"ownedBy"`
	CreatedBy uint64     `json:"createdBy"`
	CreatedAt time.Time  `json:"createdAt"`
	UpdatedBy uint64     `json:"updatedBy,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
}

type AuthClientFilter struct {
	AuthClientID []string `json:"authClientID"`

	Handle string `json:"handle"`

	Deleted filter.State `json:"deleted"`

	LabeledIDs []uint64                         `json:"-"`
	Labels     map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	// Check fn is called by store backend for each resource found function can
	// modify the resource and return false if store should not return it
	//
	// Store then loads additional resources to satisfy the paging parameters
	Check func(*AuthClient) (bool, error) `json:"-"`

	// Standard helpers for paging and sorting
	filter.Sorting
	filter.Paging
}

type AuthClientMeta struct {
	Name        string `json:"name"`
	Description string `json:"description"`
}

type AuthClientSecurity struct {
	// Impersonates a specific user;
	// ignored when non client-credentials grant is used
	ImpersonateUser uint64 `json:"impersonateUser,string,omitempty"`

	// The default user group the user falls into
	UserGroup uint64 `json:"userGroup,string,omitempty"`

	// Subset of roles, permitted to be used with this client
	// IDs are intentionally stored as strings to support JS (int64 only)
	PermittedRoles []string `json:"permittedRoles,omitempty"`

	// Subset of roles, prohibited to be used with this client
	// IDs are intentionally stored as strings to support JS (int64 only)
	ProhibitedRoles []string `json:"prohibitedRoles,omitempty"`

	// Set of additional roles that are forced on this user
	// IDs are intentionally stored as strings to support JS (int64 only)
	ForcedRoles []string `json:"forcedRoles,omitempty"`
}

type AuthClientSet []*AuthClient

type AuthConfirmedClient struct {
	UserID      uint64
	ClientID    uint64
	ConfirmedAt time.Time
}

type AuthConfirmedClientFilter struct {
	UserID uint64
	Limit  uint
}

type AuthConfirmedClientSet []*AuthConfirmedClient

type AuthOa2token struct {
	ID         uint64
	Code       string
	Access     string
	Refresh    string
	ExpiresAt  time.Time
	CreatedAt  time.Time
	Data       sqlxTypes.JSONText
	ClientID   uint64
	UserID     uint64
	RemoteAddr string
	UserAgent  string
}

type AuthOa2tokenFilter struct {
	UserID uint64
	Limit  uint
}

type AuthOa2tokenSet []*AuthOa2token

type AuthProvider struct {
	Provider string
}

type AuthSession struct {
	ID         string
	Data       []byte
	ExpiresAt  time.Time
	CreatedAt  time.Time
	UserID     uint64
	RemoteAddr string
	UserAgent  string
}

type AuthSessionFilter struct {
	UserID uint64
	Limit  uint
}

type AuthSessionSet []*AuthSession

type ByContentLength ApigwProfilerHitSet

type ByCount ApigwProfilerAggregationSet

type ByDuration ApigwProfilerHitSet

type ByFTime ApigwProfilerHitSet

type ByMethod ApigwProfilerHitSet

type ByPath ApigwProfilerAggregationSet

type BySTime ApigwProfilerHitSet

type BySizeAvg ApigwProfilerAggregationSet

type BySizeMax ApigwProfilerAggregationSet

type BySizeMin ApigwProfilerAggregationSet

type ByStatus ApigwProfilerHitSet

type ByTimeAvg ApigwProfilerAggregationSet

type ByTimeMax ApigwProfilerAggregationSet

type ByTimeMin ApigwProfilerAggregationSet

type Chatbot struct {
	ID      uint64 `json:"chatbotID,string"`
	Handle  string `json:"handle"`
	Name    string `json:"name"`
	Enabled bool   `json:"enabled"`

	WidgetKey      string                `json:"widgetKey,omitempty"`
	AllowedOrigins ChatbotAllowedOrigins `json:"allowedOrigins,omitempty"`
	SessionTTL     string                `json:"sessionTTL,omitempty"`

	Handoff   ChatbotHandoff   `json:"handoff"`
	Styling   ChatbotStyling   `json:"styling"`
	Scenarios ChatbotScenarios `json:"scenarios"`

	Labels map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
}

type ChatbotAllowedOrigins []string

type ChatbotAutomationHook struct {
	Automation string               `json:"automation"`
	Async      bool                 `json:"async"`
	Mappings   []ChatbotHookMapping `json:"mappings,omitempty"`
}

type ChatbotColors struct {
	Primary     string `json:"primary,omitempty"`
	PrimaryText string `json:"primaryText,omitempty"`
	Header      string `json:"header,omitempty"`
	HeaderText  string `json:"headerText,omitempty"`
	Background  string `json:"background,omitempty"`
	Text        string `json:"text,omitempty"`
	UserBubble  string `json:"userBubble,omitempty"`
	AgentBubble string `json:"agentBubble,omitempty"`
}

type ChatbotConsentStepState struct {
	Accepted bool      `json:"accepted"`
	At       time.Time `json:"at"`
}

type ChatbotConversationHandoffState struct {
	OperatorID   uint64 `json:"operatorID,string,omitempty"`
	OperatorName string `json:"operatorName,omitempty"`
}

type ChatbotConversationStepState struct {
	ConversationID uint64                           `json:"conversationID,string,omitempty"`
	History        []AiConversationMessage          `json:"history,omitempty"`
	Handoff        *ChatbotConversationHandoffState `json:"handoff,omitempty"`
}

type ChatbotFilter struct {
	ChatbotID []string `json:"chatbotID"`
	Handle    string   `json:"handle"`
	WidgetKey string   `json:"widgetKey"`
	Query     string   `json:"query"`

	Deleted filter.State `json:"deleted"`

	LabeledIDs []uint64                         `json:"-"`
	Labels     map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	Check func(*Chatbot) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type ChatbotFontSizes struct {
	Base    string `json:"base,omitempty"`
	Small   string `json:"small,omitempty"`
	Heading string `json:"heading,omitempty"`
}

type ChatbotFormStepState struct {
	Fields    map[string]string `json:"fields,omitempty"`
	Submitted bool              `json:"submitted,omitempty"`
}

type ChatbotHandoff struct {
	Enabled    bool                     `json:"enabled"`
	Automation ChatbotHandoffAutomation `json:"automation"`
}

type ChatbotHandoffAutomation struct {
	OnRequested ChatbotAutomationHook `json:"onRequested"`
	OnAccepted  ChatbotAutomationHook `json:"onAccepted"`
}

type ChatbotHookMapping struct {
	StateExpression ChatbotStateExpression `json:"stateExpression"`
	TriggerParam    string                 `json:"triggerParam"`
}

type ChatbotLauncher struct {
	IconURL          string `json:"iconURL,omitempty"`
	IconAttachmentID uint64 `json:"iconAttachmentID,string,omitempty"`
	IconVisible      bool   `json:"iconVisible"`
	Label            string `json:"label,omitempty"`
	ButtonLabel      string `json:"buttonLabel,omitempty"`
	Size             string `json:"size,omitempty"`
	Shape            string `json:"shape,omitempty"`
	Position         string `json:"position,omitempty"`
	StartOpen        bool   `json:"startOpen,omitempty"`
}

type ChatbotScenario struct {
	ID         string                    `json:"id"`
	Name       string                    `json:"name,omitempty"`
	Type       string                    `json:"type"`
	AgentID    uint64                    `json:"agentID,string,omitempty"`
	Config     json.RawMessage           `json:"config,omitempty"`
	Automation ChatbotScenarioAutomation `json:"automation"`
}

type ChatbotScenarioAutomation struct {
	Before ChatbotAutomationHook `json:"before"`
	After  ChatbotAutomationHook `json:"after"`
}

type ChatbotScenarios []ChatbotScenario

type ChatbotSession struct {
	ID          uint64              `json:"id,string"`
	ChatbotID   uint64              `json:"chatbotID,string"`
	Status      string              `json:"status"`
	CurrentStep int                 `json:"currentStep"`
	State       ChatbotSessionState `json:"state,omitempty"`
	CreatedAt   time.Time           `json:"createdAt,omitempty"`
	CreatedBy   uint64              `json:"createdBy,string"`
	UpdatedAt   *time.Time          `json:"updatedAt,omitempty"`
	UpdatedBy   uint64              `json:"updatedBy,string,omitempty"`
	DeletedAt   *time.Time          `json:"deletedAt,omitempty"`
	DeletedBy   uint64              `json:"deletedBy,string,omitempty"`
}

type ChatbotSessionFilter struct {
	ChatbotSessionID []uint64 `json:"chatbotSessionID"`
	ChatbotID        uint64   `json:"chatbotID"`
	Status           []string `json:"status"`
	Query            string   `json:"query"`

	Deleted filter.State `json:"deleted"`

	Check func(*ChatbotSession) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type ChatbotSessionHandoff struct {
	ID          uint64     `json:"id,string"`
	SessionID   uint64     `json:"sessionID,string"`
	StepID      uint64     `json:"stepID,string"`
	Status      string     `json:"status"`
	InitiatedAt time.Time  `json:"initiatedAt,omitempty"`
	ClosedAt    *time.Time `json:"closedAt,omitempty"`
	CreatedAt   time.Time  `json:"createdAt,omitempty"`
	CreatedBy   uint64     `json:"createdBy,string"`
	UpdatedAt   *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy   uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt   *time.Time `json:"deletedAt,omitempty"`
	DeletedBy   uint64     `json:"deletedBy,string,omitempty"`
}

type ChatbotSessionHandoffFilter struct {
	ChatbotSessionHandoffID []uint64 `json:"chatbotSessionHandoffID"`
	SessionID               uint64   `json:"sessionID"`
	StepID                  uint64   `json:"stepID"`
	Status                  string   `json:"status"`
	Query                   string   `json:"query"`

	Deleted filter.State `json:"deleted"`

	Check func(*ChatbotSessionHandoff) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type ChatbotSessionHandoffSet []*ChatbotSessionHandoff

type ChatbotSessionSet []*ChatbotSession

type ChatbotSessionState []ChatbotSessionStepState

type ChatbotSessionStep struct {
	ID             uint64     `json:"id,string"`
	SessionID      uint64     `json:"sessionID,string"`
	ScenarioIndex  int        `json:"scenarioIndex"`
	ConversationID uint64     `json:"conversationID,string"`
	Status         string     `json:"status"`
	CreatedAt      time.Time  `json:"createdAt,omitempty"`
	CreatedBy      uint64     `json:"createdBy,string"`
	UpdatedAt      *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy      uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt      *time.Time `json:"deletedAt,omitempty"`
	DeletedBy      uint64     `json:"deletedBy,string,omitempty"`
}

type ChatbotSessionStepFilter struct {
	ChatbotSessionStepID []uint64 `json:"chatbotSessionStepID"`
	SessionID            uint64   `json:"sessionID"`
	ConversationID       uint64   `json:"conversationID"`
	Status               string   `json:"status"`
	Query                string   `json:"query"`

	Deleted filter.State `json:"deleted"`

	Check func(*ChatbotSessionStep) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type ChatbotSessionStepSet []*ChatbotSessionStep

type ChatbotSessionStepState struct {
	ScenarioID string `json:"scenarioID"`
	Type       string `json:"type"`

	Conversation *ChatbotConversationStepState `json:"conversation,omitempty"`
	Form         *ChatbotFormStepState         `json:"form,omitempty"`
	Consent      *ChatbotConsentStepState      `json:"consent,omitempty"`
}

type ChatbotSet []*Chatbot

type ChatbotStateExpression struct {
	Source string      `json:"source,omitempty"`
	Expr   string      `json:"expr,omitempty"`
	Value  interface{} `json:"value,omitempty"`
	Type   string      `json:"type,omitempty"`
}

type ChatbotStyling struct {
	LogoAttachmentID uint64           `json:"logoAttachmentID,string,omitempty"`
	LogoURL          string           `json:"logoURL,omitempty"` // computed at read time; not persisted
	FontFamily       string           `json:"fontFamily,omitempty"`
	FontSizes        ChatbotFontSizes `json:"fontSizes,omitempty"`
	Colors           ChatbotColors    `json:"colors,omitempty"`
	Launcher         ChatbotLauncher  `json:"launcher,omitempty"`
}

type CodeSnippet struct {
	Name    string `json:"name"`
	Script  string `json:"script"`
	Enabled bool   `json:"enabled"`
}

type Component struct{}

type ConfiguredConnection struct {
	ID           uint64 `json:"configurationID,string"`
	ConnectionID uint64 `json:"connectionID,string"`

	Name   string `json:"name"`
	Status string `json:"status"`

	Connection Connection                 `json:"connection"`
	Config     ConfiguredConnectionConfig `json:"config"`

	Labels map[string]labelTypes.LabelValue `json:"labels,omitempty"`

	CreatedAt time.Time  `json:"createdAt,omitempty"`
	CreatedBy uint64     `json:"createdBy,string"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	UpdatedBy uint64     `json:"updatedBy,string,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	DeletedBy uint64     `json:"deletedBy,string,omitempty"`
}

type ConfiguredConnectionCheckResult struct {
	Connectivity ConfiguredConnectionCheckStatus  `json:"connectivity"`
	Auth         ConfiguredConnectionCheckStatus  `json:"auth"`
	Probe        *ConfiguredConnectionCheckStatus `json:"probe,omitempty"`
}

type ConfiguredConnectionCheckStatus struct {
	OK      bool   `json:"ok"`
	Message string `json:"message,omitempty"`
}

type ConfiguredConnectionConfig struct {
	NamespaceID     uint64 `json:"namespaceID,string"`
	DalConnectionID uint64 `json:"dalConnectionID,string"`

	CredentialID uint64                      `json:"credentialID,string"`
	Params       []ConfiguredConnectionParam `json:"params,omitempty"`

	// Discovery holds cached resource lists fetched at registration time.
	// Keyed by discovery key (e.g. "spreadsheets", "tabs").
	Discovery map[string]json.RawMessage `json:"discovery,omitempty"`
}

type ConfiguredConnectionFilter struct {
	ConnectionID uint64   `json:"connectionID,string"`
	Status       []string `json:"status"`
	Query        string   `json:"query"`

	Deleted filter.State `json:"deleted"`

	LabeledIDs []uint64 `json:"-"`

	Check func(*ConfiguredConnection) (bool, error) `json:"-"`

	filter.Paging
	filter.Sorting
}

type ConfiguredConnectionParam struct {
	Scope []string `json:"scope"`
	Name  string   `json:"name"`
	Value string   `json:"value"`
}

type ConfiguredConnectionSet []*ConfiguredConnection