# API Reference


## Client


Local and remote clients, namespace context, and permissions.


[RecapClient](RecapClient.md#recap.RecapClient)  
Primary entry point for interacting with a RECAP provenance database.

[ActorPermissions](ActorPermissions.md#recap.ActorPermissions)  
Current actor's effective permissions returned by remote APIs.

[EffectivePermissions](EffectivePermissions.md#recap.EffectivePermissions)  

[PermissionDecision](PermissionDecision.md#recap.PermissionDecision)  

[DenialCode](DenialCode.md#recap.DenialCode)  


## Queries


Immutable query composition and field predicates.


[QueryDSL](QueryDSL.md#recap.QueryDSL)  
Factory for namespace-scoped query families.

[Field](Field.md#recap.Field)  
Typed query-field expression builder.

[FieldPredicate](FieldPredicate.md#recap.FieldPredicate)  
Serializable field comparison used by `BaseQuery.where()`.

[FieldOrdering](FieldOrdering.md#recap.FieldOrdering)  
Serializable ascending or descending field ordering.

[BaseQuery](BaseQuery.md#recap.BaseQuery)  
Immutable query base with filtering, pagination, loading, and execution.

[NamespaceQuery](NamespaceQuery.md#recap.NamespaceQuery)  
Query namespaces, including local and effective metadata filters.

[ResourceQuery](ResourceQuery.md#recap.ResourceQuery)  
Query resources, properties, templates, and parent relationships.

[ResourceTemplateQuery](ResourceTemplateQuery.md#recap.ResourceTemplateQuery)  
Query resource templates and optionally hydrate child relationships.

[ProcessTemplateQuery](ProcessTemplateQuery.md#recap.ProcessTemplateQuery)  
Query process templates and optionally hydrate steps and slots.

[ProcessRunQuery](ProcessRunQuery.md#recap.ProcessRunQuery)  
Query process runs with optional steps, resources, and parameters.


## Builders


Context-managed resource and process builders.


[ResourceTemplateBuilder](ResourceTemplateBuilder.md#recap.ResourceTemplateBuilder)  

[ResourceBuilder](ResourceBuilder.md#recap.ResourceBuilder)  

[ProcessTemplateBuilder](ProcessTemplateBuilder.md#recap.ProcessTemplateBuilder)  
Builder for process templates, resource slots, and step templates.

[StepTemplateBuilder](StepTemplateBuilder.md#recap.StepTemplateBuilder)  
Scoped editor for one step's parameter groups and resource bindings.

[ProcessRunBuilder](ProcessRunBuilder.md#recap.ProcessRunBuilder)  
Builder for process-run assignments, parameters, and child steps.

[AttributeGroupBuilder](AttributeGroupBuilder.md#recap.AttributeGroupBuilder)  


## Models and Lifecycle


Public schemas, lifecycle state, directions, and copy options.


[LifecycleStatus](LifecycleStatus.md#recap.LifecycleStatus)  
Monotonic lifecycle state for persisted RECAP entities.

[Direction](Direction.md#recap.Direction)  
Direction of resource flow through a process step.

[validate_transition()](validate_transition.md#recap.validate_transition)  
Validate lifecycle transition, allowing idempotent same-state updates.

[NamespaceRef](NamespaceRef.md#recap.NamespaceRef)  
Lightweight namespace identity used in relationships and query results.

[NamespaceContext](NamespaceContext.md#recap.NamespaceContext)  
Active namespace scope attached to client queries and writes.

[NamespaceSchema](NamespaceSchema.md#recap.NamespaceSchema)  
Persisted namespace with lifecycle, hierarchy, and metadata fields.

[ResourceTypeSchema](ResourceTypeSchema.md#recap.ResourceTypeSchema)  
A type tag associated with a resource or resource template.

[ResourceCopyChanges](ResourceCopyChanges.md#recap.ResourceCopyChanges)  
Property changes applied while copying a resource.

[ResourceCopyOptions](ResourceCopyOptions.md#recap.ResourceCopyOptions)  
Name, parent, and property overrides for a resource copy operation.

[ResourceTemplateRef](ResourceTemplateRef.md#recap.ResourceTemplateRef)  
Full blueprint for a category of resources.

[ResourceTemplateSchema](ResourceTemplateSchema.md#recap.ResourceTemplateSchema)  
Full blueprint for a category of resources.

[ResourceRef](ResourceRef.md#recap.ResourceRef)  
A concrete resource instance created from a `ResourceTemplateSchema`.

[ResourceSchema](ResourceSchema.md#recap.ResourceSchema)  
A concrete resource instance created from a `ResourceTemplateSchema`.

[ResourceAssignmentSchema](ResourceAssignmentSchema.md#recap.ResourceAssignmentSchema)  
Represents the assignment of a resource to a slot in a process run.

[ProcessTemplateRef](ProcessTemplateRef.md#recap.ProcessTemplateRef)  
Blueprint for a workflow, defining its ordered steps and resource slots.

[ProcessTemplateSchema](ProcessTemplateSchema.md#recap.ProcessTemplateSchema)  
Blueprint for a workflow, defining its ordered steps and resource slots.

[ProcessRunRef](ProcessRunRef.md#recap.ProcessRunRef)  
A concrete execution of a `ProcessTemplateSchema`.

[ProcessRunSchema](ProcessRunSchema.md#recap.ProcessRunSchema)  
A concrete execution of a `ProcessTemplateSchema`.

[StepTemplateRef](StepTemplateRef.md#recap.StepTemplateRef)  
Blueprint for a single workflow step within a process template.

[StepTemplateSchema](StepTemplateSchema.md#recap.StepTemplateSchema)  
Blueprint for a single workflow step within a process template.

[StepSchema](StepSchema.md#recap.StepSchema)  
A concrete step instance within a `~recap.schemas.process.ProcessRunSchema`.

[ParameterSchema](ParameterSchema.md#recap.ParameterSchema)  
A parameter group instance attached to a step.

[AttributeTemplateSchema](AttributeTemplateSchema.md#recap.AttributeTemplateSchema)  
Persisted blueprint for a single typed attribute.

[AttributeGroupRef](AttributeGroupRef.md#recap.AttributeGroupRef)  
A named group of `AttributeTemplateSchema` instances.

[AttributeGroupTemplateSchema](AttributeGroupTemplateSchema.md#recap.AttributeGroupTemplateSchema)  
A named group of `AttributeTemplateSchema` instances.

[AttributeValueSchema](AttributeValueSchema.md#recap.AttributeValueSchema)  
A single stored attribute value with an optional physical unit.

[AttributeTemplateValidator](AttributeTemplateValidator.md#recap.AttributeTemplateValidator)  
Transient validator for a raw attribute definition supplied via the builder API.