Skip to content

cayu.collaboration.request_access

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

PreparedAdmissionRegistration

Section titled “PreparedAdmissionRegistration”
from cayu.collaboration import PreparedAdmissionRegistration

Opt in to the application-wired native FRESH receiving owner.

Native sessions and the frozen runtime budget receiver are wired by CayuApp; an admission command cannot install callbacks or choose another store.

Decorators: @dataclass(frozen=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
receiver ObjectRef required

Release source · Runtime guarantees · Capability guides

RequestAdmissionReader

Section titled “RequestAdmissionReader”
from cayu.collaboration import RequestAdmissionReader

Registered exact historical readback, not a recipient launch capability.

Implementations must authenticate the current read context on each lookup and compare the complete expected command, including effective input and native target. Receipts must come from the durable receiving owner.

Bases: ABC.

lookup (method)

Section titled “lookup (method)”
async RequestAdmissionReader.lookup(expected: RequestAdmissionCommand, *, context: MandateAccessContext) -> ExactLookup[RequestAdmissionReceipt]

Release source · Runtime guarantees · Capability guides

RequestPlanningAdmissionReader

Section titled “RequestPlanningAdmissionReader”
from cayu.collaboration import RequestPlanningAdmissionReader

Pin an existing authenticated admission reader for planning prerequisites.

Decorators: @dataclass(frozen=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
reference ObjectRef required
reader RequestAdmissionReader required

Release source · Runtime guarantees · Capability guides

RequestReceivingAuthorization

Section titled “RequestReceivingAuthorization”
from cayu.collaboration import RequestReceivingAuthorization

Historical evidence; only a registered owner’s live guard authenticates it.

Bases: ContractValue.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
receiver ObjectRef required
command RequestReceivingCommand required
expires_at_ms Millis required
settlement ReceivingSettlementReceipt | None None

bounded_input (method)

Section titled “bounded_input (method)”
RequestReceivingAuthorization.bounded_input(value: object) -> Any

immutable_fields (method)

Section titled “immutable_fields (method)”
RequestReceivingAuthorization.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestReceivingOwner

Section titled “RequestReceivingOwner”
from cayu.collaboration import RequestReceivingOwner

Trusted, non-dispatching boundary for producer evidence authentication.

Implementations must authenticate the complete command and caller, pinned policy, producer and required source evidence; a matching caller value or digest alone is insufficient. Acquire must serialize revocation with the yielded authorization until publication settles. It runs outside the store transaction and must never launch work. Missing adapters must refuse.

Bases: ABC.

ref (property)

Section titled “ref (property)”
RequestReceivingOwner.ref() -> ObjectRef

acquire (method)

Section titled “acquire (method)”
RequestReceivingOwner.acquire(command: RequestReceivingCommand, *, context: MandateAccessContext) -> AbstractAsyncContextManager[RequestReceivingAuthorization]

settlement (method)

Section titled “settlement (method)”
async RequestReceivingOwner.settlement(command: RequestReceivingCommand, expected: PermitCommand, *, context: MandateAccessContext) -> ReceivingSettlementReceipt | None

Return receiver-authenticated terminal evidence, if qualified.

Release source · Runtime guarantees · Capability guides

RequestRegistration

Section titled “RequestRegistration”
from cayu.collaboration import RequestRegistration

Decorators: @dataclass(frozen=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
mandates MandateResolver required
max_ttl_ms int required
resource_owners tuple[ResourceSelectorOwner, ...] ()
receiving_owner RequestReceivingOwner | None None
clarification_policies tuple[ClarificationPolicy, ...] ()
prepared_admission PreparedAdmissionRegistration | None None
planning_policies tuple[ConfiguredRequestPlanningPolicy, ...] ()
planning_readers tuple[RequestPlanningAdmissionReader, ...] ()

Release source · Runtime guarantees · Capability guides