openapi

type AccountAccessReply struct {
	// Reply is the reply value.
	rout.Reply
	// Allowed is the allowed value.
	Allowed bool `json:"allowed"`
}

type AccountAccessRequest struct {
	// ObjectID is the object_id value.
	ObjectID string `json:"object_id" description:"The ID of the object to check access for" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// ObjectType is the object_type value.
	ObjectType string `` /* 138-byte string literal not displayed */
	// Relation is the relation value.
	Relation string `json:"relation" description:"The relation to check access for, e.g. can_view, can_edit" example:"can_view"`
	// SubjectType is the subject_type value.
	SubjectType string `json:"subject_type,omitempty" description:"The type of subject to check access for, e.g. service, user" example:"user"`
}

type AccountFeaturesReply struct {
	// Reply is the reply value.
	rout.Reply
	// Features is the features value.
	Features []string `` /* 138-byte string literal not displayed */
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id" description:"The ID of the organization the user has features in" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountFeaturesRequest struct {
	// ID is the id value.
	ID string `param:"id" description:"The ID of the organization to check roles for" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountRolesOrganizationReply struct {
	// Reply is the reply value.
	rout.Reply
	// Roles is the roles value.
	Roles []string `json:"roles" description:"The roles the user has in the organization, e.g. can_view, can_edit"`
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id" description:"The ID of the organization the user has roles in" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountRolesOrganizationRequest struct {
	// ID is the id value.
	ID string `param:"id" description:"The ID of the organization to check roles for" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AccountRolesReply struct {
	// Reply is the reply value.
	rout.Reply
	// Roles is a list of roles the user has for the specified object(s)
	// @deprecated use ObjectRoles instead, may be removed in a future release
	Roles []string `json:"roles" description:" @deprecated use ObjectRoles instead. A list of roles the subject has for the specified object"`
	// ObjectRoles is a map of object IDs to the roles the user has for each object ID
	ObjectRoles map[string][]string `json:"object_roles,omitempty" description:"A map of object IDs to the roles the subject has for each object ID"`
}

type AccountRolesRequest struct {
	// @deprecated use ObjectIDs instead, may be removed in a future release
	ObjectID string `` /* 153-byte string literal not displayed */
	// ObjectIDs is the object_ids value.
	ObjectIDs []string `` // example:"["01J4EXD5MM60CX4YNYN0DEE3Y1", "01J4EXD5MM60CX4YNYN0DEE3Y2"]"
	/* 132-byte string literal not displayed */
	// ObjectType is the object_type value.
	ObjectType string `` /* 137-byte string literal not displayed */
	// SubjectType is the subject_type value.
	SubjectType string `json:"subject_type,omitempty" description:"The type of subject to check roles for, e.g. service, user" example:"user"`
	// Relations is the relations value.
	Relations []string `json:"relations,omitempty" description:"The relations to check roles for, e.g. can_view, can_edit"`
}

type AcmeSolverRequest struct {
	// Path is the path value.
	Path string `param:"path" description:"The path to the acme challenge" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type AuthData struct {
	// AccessToken is the access_token value.
	AccessToken string `json:"access_token" description:"The access token to be used for authentication"`
	// RefreshToken is the refresh_token value.
	RefreshToken string `json:"refresh_token,omitempty" description:"The refresh token to be used to refresh the access token after it expires"`
	// Session is the session value.
	Session string `json:"session,omitempty" description:"The short-lived session token required for authentication"`
	// TokenType is the token_type value.
	TokenType string `json:"token_type,omitempty" description:"The type of token being returned" example:"bearer"`
}

type AvailableAuthTypeLoginRequest struct {
	// Username is the username value.
	Username string `json:"username" description:"The email address associated with the existing account" example:"jsnow@example.com"`
}

type AvailableAuthTypeReply struct {
	// Reply is the reply value.
	rout.Reply
	// Methods is the methods value.
	Methods []enums.AuthProvider `json:"methods,omitempty"`
}

type CreateTrustCenterAnonymousJWTResponse struct {
	// AuthData is the authdata value.
	AuthData
}

type DeleteIntegrationRequest struct {
	// ID is the id value.
	ID string `param:"id" description:"Integration ID" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
}

type DeleteIntegrationResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
	// DeletedID is the deletedId value.
	DeletedID string `json:"deletedId,omitempty"`
}

type DisconnectIntegrationRequest struct {
	// Provider is the provider value.
	Provider string `param:"provider" description:"Integration provider key" example:"github"`
	// IntegrationID is the integrationid value.
	IntegrationID string `query:"integration_id,omitempty" description:"Specific integration ID to delete"`
}

type EndImpersonationReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message" description:"Success message"`
}

type EndImpersonationRequest struct {
	// SessionID is the session_id value.
	SessionID string `json:"session_id" validate:"required" description:"The session ID to end"`
	// Reason is the reason value.
	Reason string `json:"reason,omitempty" description:"Optional reason for ending the session"`
}

type ExampleCSVRequest struct {
	// Filename is the filename value.
	Filename string `json:"filename" description:"the file name to check for" example:"actionplan"`
}

type ExampleProvider interface {
	ExampleResponse() any
}

type File = storagetypes.File

type FileDownload struct {
	// ID is the id value.
	ID string `param:"id" description:"the file ID" example:"01J4HMNDSZCCQBTY93BF9CBF5D"`
	// Token is the token value.
	Token string `query:"token" description:"The token to be used to verify the email address, token is sent via email"`
}

type FileDownloadReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// File is the file value.
	File File `json:"file" description:"The files that were uploaded"`
}

type ForgotPasswordReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

type ForgotPasswordRequest struct {
	// Email is the email value.
	Email string `` /* 136-byte string literal not displayed */
}

type GetIntegrationStatusRequest struct {
	// Provider is the provider value.
	Provider string `param:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
}

type GetIntegrationTokenRequest struct {
	// Provider is the provider value.
	Provider string `param:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
}

type GetQuestionnaireResponse struct {
	// Jsonconfig is the jsonconfig value.
	Jsonconfig map[string]any `json:"jsonconfig,omitempty"`
	// UISchema is the uischema value.
	UISchema map[string]any `json:"uischema,omitempty"`
	// SavedData is the previously saved draft data, if any.
	SavedData map[string]any `json:"saved_data,omitempty"`
}

type GitHubAppInstallCallbackRequest struct {
	// InstallationID is the installation_id value.
	InstallationID string `json:"installation_id" query:"installation_id" description:"GitHub App installation ID" example:"12345678"`
	// SetupAction is the setup_action value.
	SetupAction string `json:"setup_action,omitempty" query:"setup_action" description:"GitHub setup action" example:"install"`
	// State is the state value.
	State string `` /* 131-byte string literal not displayed */
}

type GitHubAppInstallCallbackResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty" description:"Success or error message"`
}

type GitHubAppInstallRequest struct{}

type GitHubAppInstallResponse struct {
	// Reply is the reply value.
	rout.Reply
	// InstallURL is the installUrl value.
	InstallURL string `` /* 164-byte string literal not displayed */
	// State is the state value.
	State string `` /* 127-byte string literal not displayed */
	// Message is the message value.
	Message string `json:"message,omitempty" description:"Optional message"`
}

type GitHubAppWebhookResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Persisted is the persisted value.
	Persisted map[string]any `json:"persisted,omitempty" description:"Summary of persisted alerts"`
}

type IntegrationConfig struct {
	// OperationsTemplates holds saved operation templates for the IntegrationConfig
	OperationTemplates map[string]IntegrationOperationTemplate `json:"operationTemplates,omitempty"`
	// EnabledOperations lists which operations are enabled
	EnabledOperations []string `json:"enabledOperations,omitempty"`
	// ClientConfig holds provider-specific client configuration
	ClientConfig map[string]any `json:"clientConfig,omitempty"`
	// CollectionStrategy defines how data is collected from the provider
	CollectionStrategy string `json:"collectionStrategy,omitempty"`
	// Schedule defines the integration schedule
	Schedule string `json:"schedule,omitempty"`
	// PollInterval defines how often to poll the provider for new data
	PollInterval time.Duration `json:"pollInterval,omitempty"`
	// MappingOverrides holds the mapping overrides
	MappingOverrides map[string]IntegrationMappingOverride `json:"mappingOverrides,omitempty"`
	// RetentionPolicy definesw the data retention policy
	RetentionPolicy *IntegrationRetentionPolicy `json:"retentionPolicy,omitempty"`
}

type IntegrationConfigParams struct {
	// Provider is the provider value.
	Provider string `param:"provider" description:"Integration provider identifier" example:"gcp_scc"`
}

type IntegrationConfigPayload struct {
	// IntegrationConfigParams is the integrationconfigparams value.
	IntegrationConfigParams
	// Body is the payload value.
	Body IntegrationConfigRequest `json:"payload"`
}

type IntegrationConfigRequest struct {
	// ServiceAccountEmail is the serviceAccountEmail value.
	ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`
	// Audience is the audience value.
	Audience string `json:"audience,omitempty"`
	// ProjectID is the projectId value.
	ProjectID string `json:"projectId,omitempty"`
	// OrganizationID is the organizationId value.
	OrganizationID string `json:"organizationId,omitempty"`
	// WorkloadIdentityProvider is the workloadIdentityProvider value.
	WorkloadIdentityProvider string `json:"workloadIdentityProvider,omitempty"`
	// FindingFilter is the findingFilter value.
	FindingFilter string `json:"findingFilter,omitempty"`
	// Additional is the additional value.
	Additional map[string]any `json:"-"`
}

type IntegrationConfigResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Provider is the provider value.
	Provider string `json:"provider"`
}

type IntegrationGitHubState = state.GitHubState

type IntegrationMappingOverride struct {
	// Version is the version of the IntegrationMappingOverride
	Version string `json:"version,omitempty"`
	// FilterExpr is the filter expression for the IntegrationMappingOverride
	FilterExpr string `json:"filterExpr,omitempty"`
	// MapExpr is the mapping expression for the IntegrationMappingOverride
	MapExpr string `json:"mapExpr,omitempty"`
}

type IntegrationOAuthMetadata struct {
	// AuthURL is the authUrl value.
	AuthURL string `json:"authUrl,omitempty"`
	// TokenURL is the tokenUrl value.
	TokenURL string `json:"tokenUrl,omitempty"`
	// RedirectURI is the redirectUri value.
	RedirectURI string `json:"redirectUri,omitempty"`
	// Scopes is the scopes value.
	Scopes []string `json:"scopes,omitempty"`
	// UsePKCE is the usePkce value.
	UsePKCE bool `json:"usePkce,omitempty"`
	// AuthParams is the authParams value.
	AuthParams map[string]string `json:"authParams,omitempty"`
	// TokenParams is the tokenParams value.
	TokenParams map[string]string `json:"tokenParams,omitempty"`
}

type IntegrationOperationMetadata struct {
	// Name is the name value.
	Name string `json:"name"`
	// Kind is the kind value.
	Kind string `json:"kind"`
	// Description is the description value.
	Description string `json:"description,omitempty"`
	// Client is the client value.
	Client string `json:"client,omitempty"`
	// ConfigSchema is the configSchema value.
	ConfigSchema map[string]any `json:"configSchema,omitempty"`
}

type IntegrationOperationParams struct {
	// Provider is the provider value.
	Provider string `param:"provider" description:"Integration provider identifier" example:"gcp_scc"`
}

type IntegrationOperationPayload struct {
	// IntegrationOperationParams is the integrationoperationparams value.
	IntegrationOperationParams
	// Body is the payload value.
	Body IntegrationOperationRequest `json:"payload"`
}

type IntegrationOperationRequest struct {
	// Operation is the operation value.
	Operation string `json:"operation" validate:"required"`
	// Config is the config value.
	Config map[string]any `json:"config,omitempty"`
	// Force is the force value.
	Force bool `json:"force,omitempty"`
}

type IntegrationOperationResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Provider is the provider value.
	Provider string `json:"provider"`
	// Operation is the operation value.
	Operation string `json:"operation"`
	// Status is the status value.
	Status string `json:"status"`
	// Summary is the summary value.
	Summary string `json:"summary"`
	// Details is the details value.
	Details map[string]any `json:"details,omitempty"`
}

type IntegrationOperationTemplate struct {
	// Config holds the IntegrationOperationTemplate configuration
	Config map[string]any `json:"config,omitempty"`
	// AllowOverrides lists which config fields can be overridden at runtime
	AllowOverrides []string `json:"allowOverrides,omitempty"`
}

type IntegrationProviderMetadata struct {
	// Name is the name value.
	Name string `json:"name"`
	// DisplayName is the displayName value.
	DisplayName string `json:"displayName"`
	// Category is the category value.
	Category string `json:"category"`
	// AuthType is the authType value.
	AuthType types.AuthKind `json:"authType"`
	// Active is the active value.
	Active bool `json:"active"`
	// LogoURL is the logoUrl value.
	LogoURL string `json:"logoUrl,omitempty"`
	// DocsURL is the docsUrl value.
	DocsURL string `json:"docsUrl,omitempty"`
	// OAuth is the oauth value.
	OAuth *IntegrationOAuthMetadata `json:"oauth,omitempty"`
	// GoogleWorkloadIdentity is the workloadIdentity value.
	GoogleWorkloadIdentity *config.GoogleWorkloadIdentitySpec `json:"workloadIdentity,omitempty"`
	// GitHubApp is the githubApp value.
	GitHubApp *config.GitHubAppSpec `json:"githubApp,omitempty"`
	// Persistence is the persistence value.
	Persistence *config.PersistenceSpec `json:"persistence,omitempty"`
	// CredentialsSchema is the credentialsSchema value.
	CredentialsSchema map[string]any `json:"credentialsSchema,omitempty"`
	// Labels is the labels value.
	Labels map[string]string `json:"labels,omitempty"`
	// Operations is the operations value.
	Operations []IntegrationOperationMetadata `json:"operations,omitempty"`
}

type IntegrationProviderState = state.IntegrationProviderState

type IntegrationProvidersResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Schema is the schema value.
	Schema *jsonschema.Schema `json:"schema"`
	// Providers is the providers value.
	Providers []IntegrationProviderMetadata `json:"providers"`
}

type IntegrationRetentionPolicy struct {
	// StoreRawPayload indicates whether to store the raw payload
	StoreRawPayload bool `json:"storeRawPayload,omitempty"`
	// PayloadTTL defines the payload TTL
	PayloadTTL time.Duration `json:"payloadTtl,omitempty"`
}

type IntegrationSlackState = state.SlackState

type IntegrationStatusResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Provider is the provider value.
	Provider string `json:"provider"`
	// Connected is the connected value.
	Connected bool `json:"connected"`
	// Status is the status value.
	Status string `json:"status,omitempty"` // "connected", "expired", "invalid"
	// TokenValid is the tokenValid value.
	TokenValid bool `json:"tokenValid,omitempty"`
	// TokenExpired is the tokenExpired value.
	TokenExpired bool `json:"tokenExpired,omitempty"`
	// Message is the message value.
	Message string `json:"message"`
	// Integration is the integration value.
	Integration any `json:"integration,omitempty"` // Will be *ent.Integration
}

type IntegrationToken struct {
	// Provider is the provider value.
	Provider string `json:"provider" description:"OAuth provider (github, slack, etc.)"`
	// AccessToken is the accessToken value.
	AccessToken string `json:"accessToken" description:"OAuth access token"`
	// RefreshToken is the refreshToken value.
	RefreshToken string `json:"refreshToken,omitempty" description:"OAuth refresh token"`
	// ExpiresAt is the expiresAt value.
	ExpiresAt *time.Time `json:"expiresAt,omitempty" description:"Token expiration time"`
	// ProviderUserID is the providerUserId value.
	ProviderUserID string `json:"providerUserId,omitempty" description:"User ID from the OAuth provider"`
	// ProviderUsername is the providerUsername value.
	ProviderUsername string `json:"providerUsername,omitempty" description:"Username from the OAuth provider"`
	// ProviderEmail is the providerEmail value.
	ProviderEmail string `json:"providerEmail,omitempty" description:"Email from the OAuth provider"`
}

type IntegrationTokenResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Provider is the provider value.
	Provider string `json:"provider"`
	// Token is the token value.
	Token *IntegrationToken `json:"token"`
	// ExpiresAt is the expiresAt value.
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
}

type InviteReply struct {
	// Reply is the reply value.
	rout.Reply
	// ID is the user_id value.
	ID string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// Email is the email value.
	Email string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	// Message is the message value.
	Message string `json:"message"`
	// JoinedOrgID is the joined_org_id value.
	JoinedOrgID string `json:"joined_org_id" description:"The ID of the organization the user joined" example:"01JJFVMGENQS9ZG3GVA50QVX5E"`
	// Role is the role value.
	Role string `json:"role" description:"The role the user has in the organization" example:"admin"`
	// NeedsSSO is the needs_sso value.
	NeedsSSO bool `json:"needs_sso,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

type InviteRequest struct {
	// Token is the token value.
	Token string `query:"token" description:"The token to be used to accept the invitation, token is sent via email"`
}

type JobRunnerRegistrationReply struct {
	// Reply is the reply value.
	Reply rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

type JobRunnerRegistrationRequest struct {
	// IPAddress is the ip_address value.
	IPAddress string `json:"ip_address" description:"The IP address of the node being registered"`
	// Token is the token value.
	Token string `json:"token" description:"Your agent registration token"`
	// Name is the name value.
	Name string `json:"name" description:"the name of your job runner node"`
	// Tags is the tags value.
	Tags []string `json:"tags" description:"The tags for your runner node"`
}

type ListIntegrationsResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Integrations is the integrations value.
	Integrations any `json:"integrations"` // Will be []*ent.Integration
}

type LoginReply struct {
	// Reply is the reply value.
	rout.Reply
	// AuthData is the authdata value.
	AuthData
	// TFAEnabled is the tfa_enabled value.
	TFAEnabled bool `json:"tfa_enabled,omitempty"`
	// TFASetupRequired is the tfa_required value.
	TFASetupRequired bool `json:"tfa_required,omitempty"`
	// Message is the message value.
	Message string `json:"message"`
}

type LoginRequest struct {
	// Username is the username value.
	Username string `json:"username" description:"The email address associated with the existing account" example:"jsnow@example.com"`
	// Password is the password value.
	Password string `json:"password" description:"The password associated with the account" example:"Wint3rIsC0ming123!"`
}

type OAuthCallbackRequest struct {
	// Provider is the provider value.
	Provider string `json:"provider,omitempty" query:"provider" description:"OAuth provider (extracted from state)"`
	// Code is the code value.
	Code string `json:"code" query:"code" description:"OAuth authorization code"`
	// State is the state value.
	State string `json:"state" query:"state" description:"OAuth state parameter"`
}

type OAuthCallbackResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Success is the success value.
	Success bool `json:"success" description:"Whether the OAuth callback was processed successfully"`
	// Integration is the integration value.
	Integration any `json:"integration,omitempty" description:"The created/updated integration object"`
	// Message is the message value.
	Message string `json:"message" description:"Success or error message" example:"Successfully connected GitHub integration"`
}

type OAuthFlowRequest struct {
	// Provider is the provider value.
	Provider string `json:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
	// RedirectURI is the redirectUri value.
	RedirectURI string `` /* 126-byte string literal not displayed */
	// Scopes is the scopes value.
	Scopes []string `json:"scopes,omitempty" description:"Additional OAuth scopes to request"` // example: ["repo", "gist"]
}

type OAuthFlowResponse struct {
	// Reply is the reply value.
	rout.Reply
	// AuthURL is the authUrl value.
	AuthURL string `` /* 141-byte string literal not displayed */
	// State is the state value.
	State string `json:"state,omitempty" description:"OAuth state parameter for security" example:"eyJvcmdJRCI6IjAxSE..."`
	// Message is the message value.
	Message string `` /* 146-byte string literal not displayed */
	// RequiresLogin is the requiresLogin value.
	RequiresLogin bool `json:"requiresLogin,omitempty" description:"Whether user needs to login before OAuth flow"`
}

type OauthTokenRequest struct {
	// Name is the name value.
	Name string `json:"name" description:"The name of the user" example:"Jon Snow"`
	// Email is the email value.
	Email string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	// AuthProvider is the authProvider value.
	AuthProvider string `json:"authProvider" description:"The provider used to authenticate the user, e.g. google, github, etc." example:"google"`
	// ExternalUserID is the externalUserId value.
	ExternalUserID string `json:"externalUserId" description:"The ID of the user from the external provider" example:"1234567890"`
	// ExternalUserName is the externalUserName value.
	ExternalUserName string `json:"externalUserName" description:"The username of the user from the external provider" example:"jsnow"`
	// ClientToken is the clientToken value.
	ClientToken string `json:"clientToken" description:"The token provided by the external provider"`
	// Image is the image value.
	Image string `json:"image,omitempty" description:"The image URL of the user from the external provider"`
	// OrgID is the org_id value.
	OrgID string `json:"org_id,omitempty" description:"the organization id for the sso connection"`
}

type ProductCatalogReply struct {
	// Reply is the reply value.
	rout.Reply
	// Catalog is the catalog value.
	models.Catalog
}

type ProductCatalogRequest struct {
	// IncludeBeta is the includebeta value.
	IncludeBeta bool `query:"include_beta" description:"Whether to include beta products in the catalog" example:"false"`
	// IncludePrivate is the includeprivate value.
	IncludePrivate bool `query:"include_private" description:"Whether to include private products in the catalog" example:"false"`
}

type RefreshIntegrationTokenRequest struct {
	// Provider is the provider value.
	Provider string `param:"provider" description:"OAuth provider (github, slack, etc.)" example:"github"`
}

type RefreshReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

type RefreshRequest struct {
	// RefreshToken is the refresh_token value.
	RefreshToken string `json:"refresh_token" description:"The token to be used to refresh the access token after expiration"`
}

type RegisterReply struct {
	// Reply is the reply value.
	rout.Reply
	// ID is the user_id value.
	ID string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// Email is the email value.
	Email string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	// Message is the message value.
	Message string `json:"message"`
	// Token is the token value.
	Token string `json:"token,omitempty" exclude:"true"` // only used for requests against local development, excluded from OpenAPI documentation
}

type RegisterRequest struct {
	// FirstName is the first_name value.
	FirstName string `json:"first_name,omitempty" description:"The first name of the user" example:"Jon"`
	// LastName is the last_name value.
	LastName string `json:"last_name,omitempty" description:"The last name of the user" example:"Snow"`
	// Email is the email value.
	Email string `json:"email,omitempty" description:"The email address of the user" example:"jsnow@example.com"`
	// Password is the password value.
	Password string `` /* 130-byte string literal not displayed */
	// Token is the token value.
	Token *string `` /* 126-byte string literal not displayed */
}

type ResendReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

type ResendRequest struct {
	// Email is the email value.
	Email string `` /* 134-byte string literal not displayed */
}

type ResetPasswordReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

type ResetPasswordRequest struct {
	// Password is the password value.
	Password string `json:"password" description:"The new password to be used for authentication"`
	// Token is the token value.
	Token string `json:"token" description:"The token to be used to reset the password, token is sent via email"`
}

type SSOCallbackRequest struct {
	// Code is the code value.
	Code string `json:"code" query:"code" description:"authorization code" example:"abc"`
	// State is the state value.
	State string `json:"state" query:"state" description:"state value" example:"state123"`
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
}

type SSOLoginReply struct {
	// Reply is the reply value.
	rout.Reply
	// RedirectURI is the redirect_uri value.
	RedirectURI string `json:"redirect_uri,omitempty"`
}

type SSOLoginRequest struct {
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// ReturnURL is the return value.
	ReturnURL string `json:"return" query:"return" description:"return url after authentication" example:"https://app.mitb.com"`
	// IsTest is the is_test value.
	IsTest bool `json:"is_test" query:"is_test" description:"Used when testing the sso was successfully connected"`
}

type SSOStatusReply struct {
	// Reply is the reply value.
	rout.Reply
	// Enforced is the enforced value.
	Enforced bool `json:"enforced"`
	// Provider is the provider value.
	Provider enums.SSOProvider `json:"provider,omitempty"`
	// DiscoveryURL is the discovery_url value.
	DiscoveryURL string `json:"discovery_url,omitempty"`
	// SAMLSignInURL is the saml_signin_url value.
	SAMLSignInURL string `json:"saml_signin_url,omitempty"`
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id,omitempty"`
	// OrgTFAEnforced is the tfa_enforced value.
	OrgTFAEnforced bool `json:"tfa_enforced"`
	// UserTFAEnabled is the user_tfa_enabled value.
	UserTFAEnabled bool `json:"user_tfa_enabled,omitempty"`
	// IsOrgOwner is the is_org_owner value.
	IsOrgOwner bool `json:"is_org_owner,omitempty"`
}

type SSOStatusRequest struct {
	// Resource is the resource value.
	Resource string `query:"resource" description:"organization or user email to check" example:"org:01J4EXD5MM60CX4YNYN0DEE3Y1"`
}

type SSOTokenAuthorizeReply struct {
	// Reply is the reply value.
	rout.Reply
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id"`
	// TokenID is the token_id value.
	TokenID string `json:"token_id"`
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

type SSOTokenAuthorizeRequest struct {
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id" query:"organization_id" description:"organization id" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// TokenID is the token_id value.
	TokenID string `json:"token_id" query:"token_id" description:"token id to authorize" example:"01JJFVMGENQS9ZG3GVA50QVX5E"`
	// TokenType is the token_type value.
	TokenType string `json:"token_type" query:"token_type" description:"token type: api or personal" example:"api"`
}

type SSOTokenCallbackRequest struct {
	// Code is the code value.
	Code string `json:"code" query:"code" description:"authorization code" example:"abc"`
	// State is the state value.
	State string `json:"state" query:"state" description:"state value" example:"state123"`
}

type SnapshotReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
	// Image is the image value.
	Image string `json:"image" description:"Base64-encoded image data of the snapshot"`
	// MIMEType is the mimeType value.
	MIMEType string `json:"mimeType" description:"MIME type of the snapshot image" example:"image/png"`
}

type SnapshotRequest struct {
	// URL is the url value.
	URL string `json:"url" description:"The URL of the domain to take a snapshot of" example:"https://www.example.com"`
	// WaitForSelector is the waitForSelector value.
	WaitForSelector string `` /* 132-byte string literal not displayed */
}

type StartImpersonationReply struct {
	// Reply is the reply value.
	rout.Reply
	// Token is the token value.
	Token string `json:"token" description:"The impersonation token"`
	// ExpiresAt is the expires_at value.
	ExpiresAt time.Time `json:"expires_at" description:"When the impersonation token expires"`
	// SessionID is the session_id value.
	SessionID string `json:"session_id" description:"The impersonation session ID"`
	// Message is the message value.
	Message string `json:"message" description:"Success message"`
}

type StartImpersonationRequest struct {
	// TargetUserID is the target_user_id value.
	TargetUserID string `json:"target_user_id" validate:"required" description:"The ID of the user to impersonate"`
	// Type is the type value.
	Type string `json:"type" validate:"required,oneof=support job admin" description:"The type of impersonation (support, job, admin)"`
	// Reason is the reason value.
	Reason string `json:"reason" validate:"required,min=10,max=500" description:"Reason for the impersonation"`
	// Duration is the duration_hours value.
	Duration *int `json:"duration_hours,omitempty" description:"Duration in hours (optional, defaults to 1 hour)"`
	// Scopes is the scopes value.
	Scopes []string `json:"scopes,omitempty" description:"Specific scopes for the impersonation session"`
	// OrganizationID is the organization_id value.
	OrganizationID string `json:"organization_id,omitempty" description:"Organization context for impersonation"`
}

type StripeWebhookRequest struct {
	// APIVersion is the apiversion value.
	APIVersion string `query:"api_version" description:"Stripe API version for this webhook request" example:"2024-11-20.acacia"`
}

type SubmitQuestionnaireRequest struct {
	// AssessmentID is the assessment_id value.
	AssessmentID string `json:"assessment_id,omitempty"`
	// Data is the data value.
	Data map[string]any `json:"data" binding:"required"`
	// IsDraft when true saves partial progress without completing the questionnaire.
	IsDraft bool `json:"is_draft,omitempty"`
}

type SubmitQuestionnaireResponse struct {
	// DocumentDataID is the document_data_id value.
	DocumentDataID string `json:"document_data_id"`
	// Status is the status value.
	Status string `json:"status"`
	// CompletedAt is the completed_at value.
	CompletedAt string `json:"completed_at,omitempty"`
}

type SwitchOrganizationReply struct {
	// Reply is the reply value.
	rout.Reply
	// AuthData is the authdata value.
	AuthData
	// NeedsSSO is the needs_sso value.
	NeedsSSO bool `json:"needs_sso,omitempty"`
	// NeedsTFA is the needs_tfa value.
	NeedsTFA bool `json:"needs_tfa,omitempty"`
	// RedirectURI is the redirect_uri value.
	RedirectURI string `json:"redirect_uri,omitempty"`
}

type SwitchOrganizationRequest struct {
	// TargetOrganizationID is the target_organization_id value.
	TargetOrganizationID string `json:"target_organization_id" description:"The ID of the organization to switch to" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
}

type TFAReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message"`
}

type TFARequest struct {
	// TOTPCode is the totp_code value.
	TOTPCode string `` /* 127-byte string literal not displayed */
	// RecoveryCode is the recovery_code value.
	RecoveryCode string `` /* 133-byte string literal not displayed */
}

type UploadFilesReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// FileCount is the file_count value.
	FileCount int64 `json:"file_count,omitempty" description:"The number of files uploaded"`
	// Files is the files value.
	Files []File `json:"files,omitempty" description:"The files that were uploaded"`
}

type UploadFilesRequest struct {
	// UploadFile is the uploadfile value.
	UploadFile multipart.FileHeader `form:"uploadFile" description:"The file to be uploaded"`
}

type UserInfoReply struct {
	// Reply is the reply value.
	rout.Reply
	// ID is the id value.
	ID string `json:"id" description:"The ID of the user" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// Email is the email value.
	Email string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	// FirstName is the first_name value.
	FirstName string `json:"first_name,omitempty" description:"The first name of the user" example:"Jon"`
	// LastName is the last_name value.
	LastName string `json:"last_name,omitempty" description:"The last name of the user" example:"Snow"`
	// DisplayName is the display_name value.
	DisplayName string `json:"display_name,omitempty" description:"The display name of the user" example:"Jon Snow"`
	// AvatarRemoteURL is the avatar_remote_url value.
	AvatarRemoteURL *string `json:"avatar_remote_url,omitempty" description:"URL of the user's remote avatar" example:"https://example.com/avatar.jpg"`
	// LastSeen is the last_seen value.
	LastSeen *string `json:"last_seen,omitempty" description:"The time the user was last seen" example:"2023-01-01T00:00:00Z"`
	// Role is the role value.
	Role string `json:"role,omitempty" description:"The user's role" example:"ADMIN"`
	// Sub is the sub value.
	Sub string `json:"sub" description:"The subject of the user JWT" example:"user123"`
}

type VerifyReply struct {
	// Reply is the reply value.
	rout.Reply
	// ID is the user_id value.
	ID string `json:"user_id" description:"The ID of the user that was created" example:"01J4EXD5MM60CX4YNYN0DEE3Y1"`
	// Email is the email value.
	Email string `json:"email" description:"The email address of the user" example:"jsnow@example.com"`
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

type VerifyRequest struct {
	// Token is the token value.
	Token string `query:"token" description:"The token to be used to verify the email address, token is sent via email"`
}

type VerifySubscribeReply struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
}

type VerifySubscribeRequest struct {
	// Token is the token value.
	Token string `query:"token" description:"The token to be used to verify the subscription, token is sent via email"`
}

type WebauthnBeginLoginResponse struct {
	// Reply is the reply value.
	Reply rout.Reply
	// CredentialAssertion is the credentialassertion value.
	*protocol.CredentialAssertion
	// Session is the session value.
	Session string `json:"session,omitempty"`
}

type WebauthnBeginRegistrationResponse struct {
	// Reply is the reply value.
	Reply rout.Reply
	// CredentialCreation is the credentialcreation value.
	*protocol.CredentialCreation
	// Session is the session value.
	Session string `json:"session,omitempty"`
}

type WebauthnLoginFinishRequest struct {
	// ID is the id value.
	ID string `json:"id" description:"The credential ID"`
	// RawID is the rawId value.
	RawID string `json:"rawId" description:"The raw credential ID"`
	// Type is the type value.
	Type string `json:"type" description:"The credential type, should be 'public-key'"`
	// AuthenticatorAttachment is the authenticatorAttachment value.
	AuthenticatorAttachment string `json:"authenticatorAttachment,omitempty" description:"How the authenticator is attached"`
	// ClientExtensionResults is the clientExtensionResults value.
	ClientExtensionResults map[string]interface{} `json:"clientExtensionResults,omitempty" description:"Extension results"`
	// Response is the response value.
	Response struct {
		AuthenticatorData string `json:"authenticatorData" description:"The authenticator data"`
		ClientDataJSON    string `json:"clientDataJSON" description:"The client data JSON"`
		Signature         string `json:"signature" description:"The assertion signature"`
		UserHandle        string `json:"userHandle,omitempty" description:"The user handle"`
	} `json:"response" description:"The authenticator response"`
}

type WebauthnLoginRequest struct {
	// Email is the email value.
	Email string `json:"email,omitempty" description:"The email address associated with the account" example:"jsnow@example.com"`
}

type WebauthnLoginResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

type WebauthnRegistrationFinishRequest struct {
	// ID is the id value.
	ID string `json:"id" description:"The credential ID"`
	// RawID is the rawId value.
	RawID string `json:"rawId" description:"The raw credential ID"`
	// Type is the type value.
	Type string `json:"type" description:"The credential type, should be 'public-key'"`
	// AuthenticatorAttachment is the authenticatorAttachment value.
	AuthenticatorAttachment string `json:"authenticatorAttachment,omitempty" description:"How the authenticator is attached"`
	// ClientExtensionResults is the clientExtensionResults value.
	ClientExtensionResults map[string]interface{} `json:"clientExtensionResults,omitempty" description:"Extension results"`
	// Response is the response value.
	Response struct {
		AttestationObject  string   `json:"attestationObject" description:"The attestation object"`
		ClientDataJSON     string   `json:"clientDataJSON" description:"The client data JSON"`
		PublicKey          string   `json:"publicKey,omitempty" description:"The public key"`
		PublicKeyAlgorithm int      `json:"publicKeyAlgorithm,omitempty" description:"The public key algorithm"`
		Transports         []string `json:"transports,omitempty" description:"Available transports"`
		AuthenticatorData  string   `json:"authenticatorData,omitempty" description:"The authenticator data"`
	} `json:"response" description:"The authenticator response"`
}

type WebauthnRegistrationRequest struct {
	// Email is the email value.
	Email string `json:"email" description:"The email address associated with the account" example:"jsnow@example.com"`
	// Name is the name value.
	Name string `json:"name,omitempty" description:"The name of the user" example:"Jon Snow"`
}

type WebauthnRegistrationResponse struct {
	// Reply is the reply value.
	rout.Reply
	// Message is the message value.
	Message string `json:"message,omitempty"`
	// AuthData is the authdata value.
	AuthData
}

type WebfingerRequest struct {
	// Resource is the resource value.
	Resource string `query:"resource" description:"resource identifier prefixed with org: or acct:" example:"acct:meowmeow@kitties.com"`
}