# Typed models

Every typed model re-exported from `pyfsr.models` -- the shapes returned by
the client APIs and the validated argument bundles accepted by the write
verbs.

```{note}
This page is generated from `pyfsr.models.__all__`. The classes themselves
live in private submodules (`_playbooks.py`, `_generated.py`, …), which
autoapi does not page -- so documenting them here under their **public**
name is what gives `pyfsr.models.X` a resolvable target. Without it every
`{class}`~pyfsr.models.X`` cross-reference in the docs is silently dead.
```

## Records (module entities)

```{eval-rst}
.. autoclass:: pyfsr.models.Alert
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Comment
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Incident
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Task
   :members:
   :undoc-members:
   :show-inheritance:
```

## Integrations & connectors

```{eval-rst}
.. autoclass:: pyfsr.models.ApiResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConfigValidationError
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConfigValidationResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorConfig
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorConfigSummary
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorDefinition
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.DependencyStatus
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.EnsureVersionResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ExecuteResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ExportJobResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.HealthcheckResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ImportJobResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.IngestionMetadata
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.IngestionPlaybooks
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.IngestionSetupResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.IngestionStatus
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.IngestionTeardownResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.InstallJobStatus
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.InstalledConnector
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.IntegrationListEnvelope
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.LogMessage
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Operation
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.OperationParam
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ParamOption
   :members:
   :undoc-members:
   :show-inheritance:
```

## Playbooks & runs

```{eval-rst}
.. autoclass:: pyfsr.models.ApprovalRequest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.CreatePlaybookRequest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.CreateVersionRequest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PlaybookVersion
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ResumeRequest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunEnv
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunFailure
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunNode
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunStep
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunStepSnapshot
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RunSummary
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TriggerActionRequest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TriggerRequest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TriggerResponse
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.VersionDiff
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.VersionStepDelta
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.WaitProgress
   :members:
   :undoc-members:
   :show-inheritance:
```

## Module administration

```{eval-rst}
.. autoclass:: pyfsr.models.AttributeBulkAction
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AttributeMetadata
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AttributeValidation
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.DefaultSortEntry
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.InvalidDraft
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ModuleDescriptions
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ModuleMetadata
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PendingChange
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PublishedModelMetadata
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StagingModelMetadata
   :members:
   :undoc-members:
   :show-inheritance:
```

## Export / import

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorSelection
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ModuleSelection
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PlaybookCollectionSelection
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RecordSet
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ViewTemplateSelection
   :members:
   :undoc-members:
   :show-inheritance:
```

## System & platform

```{eval-rst}
.. autoclass:: pyfsr.models.AIAgent
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AggregateRow
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ApiKey
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ApiKeyMaterial
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ApiKeyUser
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Appliance
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Attachment
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorOperation
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorVersionInfo
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ContentHubConnector
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ContentHubItem
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.DailyActionCount
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.EmailTemplate
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ExportConnectorRef
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ExportOptions
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ExportTemplate
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.FeaturedTag
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.FileRecord
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ImportJob
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ManualInput
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ManualInputForm
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ManualInputOption
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ManualInputResume
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ManualInputSchema
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ManualInputVariable
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ModulePermission
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.NavigationView
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Notification
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.NotificationPurge
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PicklistItem
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PicklistName
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PostInstallConfig
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PostInstallWidget
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.QueryDefinition
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.QueryFilter
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RepoConnectorEntry
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Report
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ResponseMapping
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ReusableBlock
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Role
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.SolutionPack
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.SolutionPackInfo
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.SolutionPackInstallResponse
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.SystemQuery
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.SystemViewTemplate
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Team
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.User
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Widget
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.WidgetInfo
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.Workflow
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.WorkflowCollection
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.WorkflowRun
   :members:
   :undoc-members:
   :show-inheritance:
```

## AI & investigations

```{eval-rst}
.. autoclass:: pyfsr.models.AgentConfig
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentConfigDTO
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentRecord
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentRunResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ConnectorMcpCandidates
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.InvestigationHandle
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.InvestigationQuestion
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.InvestigationResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.LLMConfig
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.LLMProvider
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.MCPServerConfig
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.MCPServerRef
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.MCPServerStatus
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.MCPTool
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.MCPToolResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.MCPValidateResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ToolCall
   :members:
   :undoc-members:
   :show-inheritance:
```

## Agents

```{eval-rst}
.. autoclass:: pyfsr.models.Agent
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentConnectorStatus
   :members:
   :undoc-members:
   :show-inheritance:
```

## AI agent packages

```{eval-rst}
.. autoclass:: pyfsr.models.AgentInfo
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentMemory
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentPackage
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentPrompt
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.AgentPromptFile
   :members:
   :undoc-members:
   :show-inheritance:
```

## Rules

```{eval-rst}
.. autoclass:: pyfsr.models.DeliveryRule
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.PreprocessingRule
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RuleChannel
   :members:
   :undoc-members:
   :show-inheritance:
```

## Schedules

```{eval-rst}
.. autoclass:: pyfsr.models.CrontabScheduleModel
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ScheduledTask
   :members:
   :undoc-members:
   :show-inheritance:
```

## Widgets

```{eval-rst}
.. autoclass:: pyfsr.models.WidgetRecord
   :members:
   :undoc-members:
   :show-inheritance:
```

## App configuration

```{eval-rst}
.. autoclass:: pyfsr.models.NavItem
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.NavRequire
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.NavState
   :members:
   :undoc-members:
   :show-inheritance:
```

## Base classes

```{eval-rst}
.. autoclass:: pyfsr.models.BaseRecord
   :members:
   :undoc-members:
   :show-inheritance:
```

## _audit

```{eval-rst}
.. autoclass:: pyfsr.models.AuditActivity
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.ExecutionContext
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.LifecycleEntry
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.RecordLifecycle
   :members:
   :undoc-members:
   :show-inheritance:
```

## _stix

```{eval-rst}
.. autoclass:: pyfsr.models.StixAttackPattern
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixBundle
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixCampaign
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixIndicator
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixIntrusionSet
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixMalware
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixObject
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixReport
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixThreatActor
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixTool
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.StixVulnerability
   :members:
   :undoc-members:
   :show-inheritance:
```

## _taxii

```{eval-rst}
.. autoclass:: pyfsr.models.StixBundleResult
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TaxiiCollection
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TaxiiDiscovery
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TaxiiManifest
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TaxiiManifestEntry
   :members:
   :undoc-members:
   :show-inheritance:
```

```{eval-rst}
.. autoclass:: pyfsr.models.TaxiiObjectsEnvelope
   :members:
   :undoc-members:
   :show-inheritance:
```