types

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"`
}

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"`

		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 "Corteza"
				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"`

	// 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 {
			SassInstalled bool `kv:"sass-installed" json:"sass-installed"`

			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"`

			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"`
		} `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"`
	} `kv:"ui" json:"ui"`

	ResourceTranslations struct {

		// This is always a subset of all languages available
		// in Corteza 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]string `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]string `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]string `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]string `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"`

	// 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 Component struct{}

type ConnectionConfig struct {
	// DAL configuration
	// using ptr to allow nil values (when dealing with access-controlled data)
	DAL *ConnectionConfigDAL `json:"dal,omitempty"`

	// Privacy configuration
	Privacy ConnectionConfigPrivacy `json:"privacy"`
}

type ConnectionConfigDAL struct {
	// type of connection
	Type string `json:"type"`

	// parameters for the connection
	Params map[string]any `json:"params"`

	// ident to be used when generating models from modules using this connection
	// it can use {{module}} and {{namespace}} as placeholders
	ModelIdent string `json:"modelIdent"`

	// set of regular-expression strings that will be used to match against
	// generated model identifiers
	ModelIdentCheck []string `json:"modelIdentCheck"`
}

type ConnectionConfigPrivacy struct {
	// Sets max-allowed data-sensitivity level for this connection
	//
	// Fields of the modules using this connection should have equal or
	// lower sensitivity level
	SensitivityLevelID uint64 `json:"sensitivityLevelID,string,omitempty"`
}

type ConnectionMeta struct {
	Name       string                   `json:"name"`
	Ownership  string                   `json:"ownership"`
	Location   geolocation.Full         `json:"location"`
	Properties ConnectionMetaProperties `json:"properties"`
}

type ConnectionMetaProperties struct {
	DataAtRestEncryption    ConnectionMetaProperty `json:"dataAtRestEncryption"`
	DataAtRestProtection    ConnectionMetaProperty `json:"dataAtRestProtection"`
	DataAtTransitEncryption ConnectionMetaProperty `json:"dataAtTransitEncryption"`
	DataRestoration         ConnectionMetaProperty `json:"dataRestoration"`
}

type ConnectionMetaProperty struct {
	Enabled bool   `json:"enabled"`
	Notes   string `json:"notes"`
}

type Credential struct {
	ID          uint64         `json:"credentialsID,string"`
	OwnerID     uint64         `json:"ownerID,string"`
	Label       string         `json:"label"`
	Kind        string         `json:"kind"`
	Credentials string         `json:"-"`
	Meta        types.JSONText `json:"-"`
	LastUsedAt  *time.Time     `json:"lastUsedAt,omitempty"`
	ExpiresAt   *time.Time     `json:"expiresAt,omitempty"`
	CreatedAt   time.Time      `json:"createdAt,omitempty"`
	UpdatedAt   *time.Time     `json:"updatedAt,omitempty"`
	DeletedAt   *time.Time     `json:"deletedAt,omitempty"`
}

type CredentialFilter struct {
	OwnerID     uint64       `json:"ownerID"`
	Kind        string       `json:"kind"`
	Credentials string       `json:"credentials"`
	Deleted     filter.State `json:"deleted"`
	Limit       uint
}

type CredentialSet []*Credential

type DalConnection struct {
	ID     uint64 `json:"connectionID,string"`
	Handle string `json:"handle"`
	Type   string `json:"type"`

	// descriptions, notes, and other user-provided meta-data
	Meta ConnectionMeta `json:"meta"`

	// collection of configurations for various subsystems that
	// use this connection and how it affects their behaviour
	Config ConnectionConfig `json:"config"`

	Issues []dal.Issue `json:"issues,omitempty"`

	Labels map[string]string `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 DalConnectionFilter struct {
	DalConnectionID []string `json:"connectionID"`
	Handle          string   `json:"handle"`
	Type            string   `json:"type"`

	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(*DalConnection) (bool, error) `json:"-"`

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

type DalConnectionSet []*DalConnection

type DalSchemaAlteration struct {
	ID           uint64 `json:"alterationID,string"`
	BatchID      uint64 `json:"batchID,string"`
	DependsOn    uint64 `json:"dependsOn,string,omitempty"`
	ConnectionID uint64 `json:"connectionID,string"`
	Resource     string `json:"resource"`
	ResourceType string `json:"resourceType"`

	Kind   string                     `json:"kind"`
	Params *DalSchemaAlterationParams `json:"params"`

	Error string `json:"error,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"`

	CompletedAt *time.Time `json:"completedAt,omitempty"`
	CompletedBy uint64     `json:"completedBy,string,omitempty"`
	DismissedAt *time.Time `json:"dismissedAt,omitempty"`
	DismissedBy uint64     `json:"dismissedBy,string,omitempty"`
}

type DalSchemaAlterationFilter struct {
	AlterationID []string `json:"alterationID"`
	BatchID      []uint64 `json:"batchID,string"`
	Kind         string   `json:"kind"`
	Resource     []string `json:"resource"`
	ResourceType string   `json:"resourceType"`

	Deleted   filter.State `json:"deleted"`
	Completed filter.State `json:"completed"`
	Dismissed filter.State `json:"dismissed"`

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

type DalSchemaAlterationParams struct {
	AttributeAdd      *dal.AttributeAdd      `json:"attributeAdd,omitempty"`
	AttributeDelete   *dal.AttributeDelete   `json:"attributeDelete,omitempty"`
	AttributeReType   *dal.AttributeReType   `json:"attributeReType,omitempty"`
	AttributeReEncode *dal.AttributeReEncode `json:"attributeReEncode,omitempty"`
	ModelAdd          *dal.ModelAdd          `json:"modelAdd,omitempty"`
	ModelDelete       *dal.ModelDelete       `json:"modelDelete,omitempty"`
}

type DalSchemaAlterationSet []*DalSchemaAlteration

type DalSensitivityLevel struct {
	ID     uint64 `json:"sensitivityLevelID,string"`
	Handle string `json:"handle"`
	Level  int    `json:"level"`

	Meta DalSensitivityLevelMeta `json:"meta"`

	Labels map[string]string `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 DalSensitivityLevelFilter struct {
	DalSensitivityLevelID []string `json:"sensitivityLevelID"`
	Handle                string   `json:"handle"`

	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(*DalSensitivityLevel) (bool, error) `json:"-"`

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

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

type DalSensitivityLevelSet []*DalSensitivityLevel

type DataPrivacyRequest struct {
	ID uint64 `json:"requestID,string"`

	Kind   RequestKind   `json:"kind"`
	Status RequestStatus `json:"status"`

	Payload DataPrivacyRequestPayloadSet `json:"payload,omitempty"`

	RequestedAt time.Time  `json:"requestedAt,omitempty"`
	RequestedBy uint64     `json:"requestedBy,string"`
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	CompletedBy uint64     `json:"completedBy,string,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 DataPrivacyRequestComment struct {
	ID        uint64 `json:"commentID,string"`
	RequestID uint64 `json:"requestID,string"`
	Comment   string `json:"comment"`

	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 DataPrivacyRequestCommentFilter struct {
	RequestID []string `json:"requestID"`

	// 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(request *DataPrivacyRequestComment) (bool, error) `json:"-"`

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

type DataPrivacyRequestCommentSet []*DataPrivacyRequestComment

type DataPrivacyRequestFilter struct {
	RequestID   []string `json:"requestID"`
	RequestedBy []string `json:"requestedBy"`

	Query string `json:"query"`

	Kind   []string `json:"kind"`
	Status []string `json:"status"`

	// 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(request *DataPrivacyRequest) (bool, error) `json:"-"`

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

type DataPrivacyRequestPayload struct {
	ConnectionID uint64                     `json:"connectionID,string"`
	NamespaceID  uint64                     `json:"namespaceID,string"`
	ModuleID     uint64                     `json:"moduleID,string"`
	Records      []DataPrivacyRequestRecord `json:"records"`
}

type DataPrivacyRequestPayloadSet []map[string]any

type DataPrivacyRequestRecord struct {
	RecordID uint64                          `json:"recordID,string"`
	Values   []DataPrivacyRequestRecordValue `json:"values"`
}

type DataPrivacyRequestRecordValue struct {
	Name     string `json:"name"`
	Value    string `json:"value"`
	Position int    `json:"position"`
}

type DataPrivacyRequestSet []*DataPrivacyRequest

type DocumentType string

type ExternalAuthProvider struct {
	Enabled     bool   `json:"enabled"`
	Handle      string `json:"handle"`
	Label       string `json:"label"`
	Key         string `json:"-"`
	Secret      string `json:"-"`
	Scope       string `json:"scope"`
	RedirectUrl string `json:"-" kv:"redirect"`
	IssuerUrl   string `json:"-" kv:"issuer"`
	Weight      int    `json:"-"`

	// potentially just use home-brew scopes?
	Usage []string `json:"usage" kv:"usage"`

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

type ExternalAuthProviderSecurity struct {
	// Subset of roles, permitted to be used with this client
	// when authorizing via this auth provider.
	//
	// 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
	// when authorizing via this auth provider.
	//
	// 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
	// when authorizing via this auth provider.
	//
	// IDs are intentionally stored as strings to support JS (int64 only)
	ForcedRoles []string `json:"forcedRoles,omitempty"`
}

type ExternalAuthProviderSet []*ExternalAuthProvider

type ExternalAuthUser struct {
	goth.User
}

type KVDecoder interface {
	DecodeKV(SettingsKV, string) error
}

type Lang struct {
	language.Tag
}

type MailMessage struct {
	Date time.Time `json:"date"`

	Subject string `json:"subject"`

	Header MailMessageHeader `json:"header"`

	// RawBody will be base64 encoded!
	// (might contain binary data)
	RawBody []byte `json:"rawBody,string"`
}

type MailMessageHeader struct {
	// extract common addresses
	To      []*mail.Address `json:"to"`
	CC      []*mail.Address `json:"cc"`
	BCC     []*mail.Address `json:"bcc"`
	From    []*mail.Address `json:"from"`
	ReplyTo []*mail.Address `json:"replyTo"`

	Raw mail.Header `json:"raw"`
}

type PasswordConstraints struct {
	// Should the environment not enforce the constraints
	PasswordSecurity bool `kv:"-" json:"passwordSecurity"`

	// The min password length
	MinLength uint `kv:"min-length" json:"minLength"`

	// Minimum number of uppercase letters in password
	MinUpperCase uint `kv:"min-upper-case" json:"minUpperCase"`

	// Minimum number of lowercase letters in password
	MinLowerCase uint `kv:"min-lower-case" json:"minLowerCase"`

	// The min number of numeric characters
	MinNumCount uint `kv:"min-num-count" json:"minNumCount"`

	// The min number of special characters
	MinSpecialCount uint `kv:"min-special-count" json:"minSpecialCount"`
}

type Permission struct {
	Resource  string `json:"resource"`
	Operation string `json:"operation"`
}

type PrivacyDalConnection struct {
	ID     uint64 `json:"connectionID,string"`
	Handle string `json:"handle"`
	Type   string `json:"type"`

	// descriptions, notes, and other user-provided meta-data
	Meta PrivacyDalConnectionMeta `json:"meta"`

	// collection of configurations for various subsystems that
	// use this connection and how it affects their behaviour
	Config PrivacyDalConnectionConfig `json:"config"`

	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 PrivacyDalConnectionConfig struct {
	Privacy ConnectionConfigPrivacy `json:"privacy"`
}

type PrivacyDalConnectionMeta struct {
	Name      string           `json:"name"`
	Ownership string           `json:"ownership"`
	Location  geolocation.Full `json:"location"`
}

type PrivacyDalConnectionSet []*PrivacyDalConnection

type Queue struct {
	ID       uint64    `json:"queueID,string"`
	Consumer string    `json:"consumer"`
	Queue    string    `json:"queue"`
	Meta     QueueMeta `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 QueueFilter struct {
	QueueID []string     `json:"queueID"`
	Query   string       `json:"query"`
	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(*Queue) (bool, error) `json:"-"`

	filter.Sorting
	filter.Paging
}

type QueueMessage struct {
	ID        uint64     `json:"messageID"`
	Queue     string     `json:"queue"`
	Payload   []byte     `json:"payload"`
	Created   *time.Time `json:"created"`
	Processed *time.Time `json:"processed"`
}

type QueueMessageFilter struct {
	Queue string

	Processed filter.State `json:"processed"`

	filter.Sorting
	filter.Paging
}

type QueueMessageSet []*QueueMessage

type QueueMeta struct {
	PollDelay      *time.Duration `json:"poll_delay"`
	DispatchEvents bool           `json:"dispatch_events"`
}

type QueueSet []*Queue

type Reminder struct {
	ID          uint64         `json:"reminderID,string"`
	Resource    string         `json:"resource"`
	Payload     types.JSONText `json:"payload"`
	SnoozeCount uint           `json:"snoozeCount"`

	AssignedTo uint64    `json:"assignedTo,string"`
	AssignedBy uint64    `json:"assignedBy,string"`
	AssignedAt time.Time `json:"assignedAt"`

	DismissedBy uint64     `json:"dismissedBy,string"`
	DismissedAt *time.Time `json:"dismissedAt"`

	RemindAt *time.Time `json:"remindAt"`

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

type ReminderFilter struct {
	ReminderID       []uint64   `json:"reminderID"`
	Resource         string     `json:"resource"`
	AssignedTo       uint64     `json:"assignedTo,uint64"`
	ScheduledFrom    *time.Time `json:"scheduledFrom"`
	ScheduledUntil   *time.Time `json:"scheduledUntil"`
	ExcludeDismissed bool       `json:"excludeDismissed"`
	IncludeDeleted   bool       `json:"includeDeleted"`
	ScheduledOnly    bool       `json:"scheduledOnly"`

	// 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(*Reminder) (bool, error) `json:"-"`

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

type ReminderSet []*Reminder

type Report struct {
	ID     uint64      `json:"reportID,string"`
	Handle string      `json:"handle"`
	Meta   *ReportMeta `json:"meta,omitempty"`

	Scenarios ReportScenarioSet   `json:"scenarios,omitempty"`
	Sources   ReportDataSourceSet `json:"sources"`
	Blocks    ReportBlockSet      `json:"blocks"`

	Labels map[string]string `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 ReportAggregateColumn struct {
	Name  string            `json:"name"`
	Label string            `json:"label"`
	Def   *ReportFilterExpr `json:"def"`
}

type ReportAggregateColumnSet []*ReportAggregateColumn

type ReportBlock struct {
	BlockID     uint64                 `json:"blockID,string"`
	Title       string                 `json:"title"`
	Description string                 `json:"description"`
	Key         string                 `json:"key"`
	Kind        string                 `json:"kind"`
	Options     map[string]interface{} `json:"options,omitempty"`
	Elements    []interface{}          `json:"elements"`
	Sources     ReportStepSet          `json:"sources"`
	XYWH        [4]int                 `json:"xywh"`
	Layout      string                 `json:"layout"`
}

type ReportBlockSet []*ReportBlock

type ReportDataSource struct {
	Meta interface{} `json:"meta,omitempty"`
	Step *ReportStep `json:"step"`
}

type ReportDataSourceSet []*ReportDataSource

type ReportFilter struct {
	ReportID []string `json:"reportID"`

	Handle string `json:"handle"`
	Query  string `json:"query"`

	Deleted filter.State `json:"deleted"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `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(*Report) (bool, error) `json:"-"`

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

type ReportFilterExpr struct {
	*ql.ASTNode
	Error string `json:"error,omitempty"`
}

type ReportLegacyStepGroup struct {
	Name    string                   `json:"name"`
	Source  string                   `json:"source"`
	Keys    ReportAggregateColumnSet `json:"keys"`
	Columns ReportAggregateColumnSet `json:"columns"`
	Filter  *ReportFilterExpr        `json:"filter,omitempty"`
}

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

type ReportScenario struct {
	ScenarioID uint64            `json:"scenarioID,string,omitempty"`
	Label      string            `json:"label"`
	Filters    ScenarioFilterMap `json:"filters,omitempty"`
}

type ReportScenarioSet []*ReportScenario

type ReportSet []*Report

type ReportStep struct {
	Kind string `json:"kind,omitempty"`

	Load      *ReportStepLoad      `json:"load,omitempty"`
	Join      *ReportStepJoin      `json:"join,omitempty"`
	Link      *ReportStepLink      `json:"link,omitempty"`
	Aggregate *ReportStepAggregate `json:"aggregate,omitempty"`

	// @todo remove for the next set of patch/major releases.
	//       it exists just for the migration as we need to rename this one.
	Group_legacy *ReportLegacyStepGroup `json:"group,omitempty"`
}

type ReportStepAggregate struct {
	Name    string                   `json:"name"`
	Source  string                   `json:"source"`
	Keys    ReportAggregateColumnSet `json:"keys"`
	Columns ReportAggregateColumnSet `json:"columns"`
	Filter  *ReportFilterExpr        `json:"filter,omitempty"`
}

type ReportStepJoin struct {
	Name          string            `json:"name"`
	LocalSource   string            `json:"localSource"`
	LocalColumn   string            `json:"localColumn"`
	ForeignSource string            `json:"foreignSource"`
	ForeignColumn string            `json:"foreignColumn"`
	Filter        *ReportFilterExpr `json:"filter,omitempty"`
}

type ReportStepLink struct {
	Name          string            `json:"name"`
	LocalSource   string            `json:"localSource"`
	LocalColumn   string            `json:"localColumn"`
	ForeignSource string            `json:"foreignSource"`
	ForeignColumn string            `json:"foreignColumn"`
	Filter        *ReportFilterExpr `json:"filter,omitempty"`
}

type ReportStepLoad struct {
	Name       string                 `json:"name"`
	Source     string                 `json:"source"`
	Definition map[string]interface{} `json:"definition"`
	Filter     *ReportFilterExpr      `json:"filter,omitempty"`
}

type ReportStepSet []*ReportStep

type RequestKind string

type RequestStatus string

type ResourceTranslation struct {
	ID uint64 `json:"translationID,string"`

	Lang     Lang   `json:"lang"`
	Resource string `json:"resource"`
	K        string `json:"key"`
	Message  string `json:"message"`

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

	OwnedBy   uint64 `json:"ownedBy,string"`
	CreatedBy uint64 `json:"createdBy,string" `
	UpdatedBy uint64 `json:"updatedBy,string,omitempty" `
	DeletedBy uint64 `json:"deletedBy,string,omitempty" `
}

type ResourceTranslationFilter struct {
	TranslationID []string `json:"translationID"`
	Lang          string   `json:"lang"`
	Resource      string   `json:"resource"`
	ResourceType  string   `json:"resourceType"`
	OwnerID       uint64   `json:"ownerID,string"`

	Deleted filter.State `json:"deleted"`

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

type ResourceTranslationSet []*ResourceTranslation

type Role struct {
	ID     uint64 `json:"roleID,string"`
	Name   string `json:"name"`
	Handle string `json:"handle"`

	Meta   *RoleMeta         `json:"meta"`
	Labels map[string]string `json:"labels,omitempty"`

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

type RoleContext struct {
	Resource []string `json:"resourceTypes,omitempty" yaml:"resourceType"`
	Expr     string   `json:"expr,omitempty"`
}

type RoleFilter struct {
	RoleID   []string `json:"roleID"`
	MemberID uint64   `json:"memberID,string"`

	Query string `json:"query"`

	Handle string `json:"handle"`
	Name   string `json:"name"`

	Deleted  filter.State `json:"deleted"`
	Archived filter.State `json:"archived"`

	LabeledIDs []uint64          `json:"-"`
	Labels     map[string]string `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(*Role) (bool, error) `json:"-"`

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

type RoleMember struct {
	RoleID uint64
	UserID uint64
}

type RoleMemberFilter struct {
	RoleID uint64
	UserID uint64
	Limit  uint
}

type RoleMemberSet []*RoleMember

type RoleMeta struct {
	Description string       `json:"description,omitempty"`
	Context     *RoleContext `json:"context,omitempty"`
}