querysvc

type Auther interface {
	// JWTAuth implements the authorization logic for the JWT security scheme.
	JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error)
}

type BadRequestError struct {
	// Error message
	Message string
}

type Client struct {
	QueryResourcesEndpoint      goa.Endpoint
	QueryResourcesCountEndpoint goa.Endpoint
	QueryOrgsEndpoint           goa.Endpoint
	SuggestOrgsEndpoint         goa.Endpoint
	ReadyzEndpoint              goa.Endpoint
	LivezEndpoint               goa.Endpoint
}

type Endpoints struct {
	QueryResources      goa.Endpoint
	QueryResourcesCount goa.Endpoint
	QueryOrgs           goa.Endpoint
	SuggestOrgs         goa.Endpoint
	Readyz              goa.Endpoint
	Livez               goa.Endpoint
}

type InternalServerError struct {
	// Error message
	Message string
}

type NotFoundError struct {
	// Error message
	Message string
}

type Organization struct {
	// Organization name
	Name *string
	// Organization domain
	Domain *string
	// Organization industry classification
	Industry *string
	// Business sector classification
	Sector *string
	// Employee count or range
	Employees *string
}

type OrganizationSuggestion struct {
	// Organization name
	Name string
	// Organization domain
	Domain string
	// Organization logo URL
	Logo *string
}

type QueryOrgsPayload struct {
	// Token
	BearerToken string
	// Version of the API
	Version string
	// Organization name
	Name *string
	// Organization domain or website URL
	Domain *string
}

type QueryResourcesCountPayload struct {
	// JWT token issued by Heimdall
	BearerToken string
	// Version of the API
	Version string
	// Resource name or alias; supports typeahead
	Name *string
	// Parent (for navigation; varies by object type)
	Parent *string
	// Resource type to search
	Type *string
	// Tags to search with OR logic - matches resources with any of these tags
	Tags []string
	// Tags to search with AND logic - matches resources that have all of these tags
	TagsAll []string
	// Date field to filter on (within data object) - used with date_from and/or
	// date_to. Supports ISO 8601 datetime (2006-01-02T15:04:05Z) or date-only
	// (2006-01-02, assumes UTC)
	DateField *string
	// Start date (inclusive). Format: ISO 8601 datetime or date-only. Date-only
	// uses start of day UTC. Requires date_field.
	DateFrom *string
	// End date (inclusive). Format: ISO 8601 datetime or date-only. Date-only uses
	// end of day UTC. Requires date_field.
	DateTo *string
	// Direct field filters with term clauses on data fields - format:
	// 'field:value' (e.g., 'status:active'). Fields are automatically prefixed
	// with 'data.'
	Filters []string
	// Direct field filters with term clauses on data fields using AND logic -
	// format: 'field:value' (e.g., 'status:active'). Fields are automatically
	// prefixed with 'data.'. Matches resources that satisfy all of the provided
	// filters.
	FiltersAll []string
	// Direct field filters with term clauses on data fields using OR logic -
	// format: 'field:value' (e.g., 'status:active'). Fields are automatically
	// prefixed with 'data.'. Matches resources that satisfy at least one of the
	// provided filters.
	FiltersOr []string
}

type QueryResourcesCountResult struct {
	// Count of resources found
	Count uint64
	// True if count is not guaranteed to be exhaustive: client should request a
	// narrower query
	HasMore bool
	// Cache control header
	CacheControl *string
}

type QueryResourcesPayload struct {
	// Token
	BearerToken string
	// Version of the API
	Version string
	// Resource name or alias; supports typeahead
	Name *string
	// Parent (for navigation; varies by object type)
	Parent *string
	// Resource type to search
	Type *string
	// Tags to search with OR logic - matches resources with any of these tags
	Tags []string
	// Tags to search with AND logic - matches resources that have all of these tags
	TagsAll []string
	// Date field to filter on (within data object) - used with date_from and/or
	// date_to. Supports ISO 8601 datetime (2006-01-02T15:04:05Z) or date-only
	// (2006-01-02, assumes UTC)
	DateField *string
	// Start date (inclusive). Format: ISO 8601 datetime or date-only. Date-only
	// uses start of day UTC. Requires date_field.
	DateFrom *string
	// End date (inclusive). Format: ISO 8601 datetime or date-only. Date-only uses
	// end of day UTC. Requires date_field.
	DateTo *string
	// Direct field filters with term clauses on data fields - format:
	// 'field:value' (e.g., 'status:active'). Fields are automatically prefixed
	// with 'data.'
	Filters []string
	// Direct field filters with term clauses on data fields using AND logic -
	// format: 'field:value' (e.g., 'status:active'). Fields are automatically
	// prefixed with 'data.'. Matches resources that satisfy all of the provided
	// filters.
	FiltersAll []string
	// Direct field filters with term clauses on data fields using OR logic -
	// format: 'field:value' (e.g., 'status:active'). Fields are automatically
	// prefixed with 'data.'. Matches resources that satisfy at least one of the
	// provided filters.
	FiltersOr []string
	// CEL expression to filter results on resource data fields. Available
	// variables: data (map), resource_type (string), id (string)
	CelFilter *string
	// Filter results to only resources the authenticated user has direct FGA
	// grants on. Requires type. Use 'direct' to filter by direct grants.
	FilterGrants *string
	// Sort order for results
	Sort string
	// Opaque token for pagination
	PageToken *string
	// Number of results per page
	PageSize int
}

type QueryResourcesResult struct {
	// Resources found
	Resources []*Resource
	// Opaque token if more results are available
	PageToken *string
	// Cache control header
	CacheControl *string
}

type Resource struct {
	// Resource type
	Type *string
	// Resource ID (within its resource collection)
	ID *string
	// Resource data snapshot
	Data any
}

type Service interface {
	// Locate resources by their type or parent, or use typeahead search to query
	// resources by a display name or similar alias.
	QueryResources(context.Context, *QueryResourcesPayload) (res *QueryResourcesResult, err error)
	// Count matching resources by query.
	QueryResourcesCount(context.Context, *QueryResourcesCountPayload) (res *QueryResourcesCountResult, err error)
	// Locate a single organization by name or domain.
	QueryOrgs(context.Context, *QueryOrgsPayload) (res *Organization, err error)
	// Get organization suggestions for typeahead search based on a query.
	SuggestOrgs(context.Context, *SuggestOrgsPayload) (res *SuggestOrgsResult, err error)
	// Check if the service is able to take inbound requests.
	Readyz(context.Context) (res []byte, err error)
	// Check if the service is alive.
	Livez(context.Context) (res []byte, err error)
}

type ServiceUnavailableError struct {
	// Error message
	Message string
}

type SuggestOrgsPayload struct {
	// Token
	BearerToken string
	// Version of the API
	Version string
	// Search query for organization suggestions
	Query string
}

type SuggestOrgsResult struct {
	// Organization suggestions
	Suggestions []*OrganizationSuggestion
}