cayu.collaboration.prepared_admission
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.
ContinueRecipientAdmissionTarget
Section titled “ContinueRecipientAdmissionTarget”from cayu.collaboration import ContinueRecipientAdmissionTargetExact native completed boundary, independently checked by its receiver.
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 |
|---|---|---|
kind |
Literal['continue'] |
'continue' |
selection |
RecipientContinuationSelection |
required |
bounded_input (method)
Section titled “bounded_input (method)”ContinueRecipientAdmissionTarget.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ContinueRecipientAdmissionTarget.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ForkRecipientAdmissionTarget
Section titled “ForkRecipientAdmissionTarget”from cayu.collaboration import ForkRecipientAdmissionTargetExact native child and historical selection; never current disclosure rights.
Bases: _CreatedRecipientAdmissionTarget.
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 |
|---|---|---|
creation |
SessionCreationTarget |
required |
session_id |
Identifier |
required |
session_instance_id |
Identifier |
required |
creation_receipt_commitment |
NativeCommitment |
required |
initial_input_commitment |
NativeCommitment |
required |
definition_commitment |
NativeCommitment |
required |
resources |
tuple[ResourceMaterialReference, ...] |
Field(default=(), max_length=32) |
kind |
Literal['fork'] |
'fork' |
selected_view_commitment |
NativeCommitment |
required |
manifest_commitment |
NativeCommitment |
required |
view_id |
Identifier |
required |
source_session_id |
Identifier |
required |
source_session_instance_id |
Identifier |
required |
bounded_input (method)
Section titled “bounded_input (method)”ForkRecipientAdmissionTarget.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ForkRecipientAdmissionTarget.immutable_fields() -> ContractValuerequested_identity (method)
Section titled “requested_identity (method)”ForkRecipientAdmissionTarget.requested_identity()Release source · Runtime guarantees · Capability guides
FreshRecipientAdmissionTarget
Section titled “FreshRecipientAdmissionTarget”from cayu.collaboration import FreshRecipientAdmissionTargetBases: _CreatedRecipientAdmissionTarget.
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 |
|---|---|---|
creation |
SessionCreationTarget |
required |
session_id |
Identifier |
required |
session_instance_id |
Identifier |
required |
creation_receipt_commitment |
NativeCommitment |
required |
initial_input_commitment |
NativeCommitment |
required |
definition_commitment |
NativeCommitment |
required |
resources |
tuple[ResourceMaterialReference, ...] |
Field(default=(), max_length=32) |
kind |
Literal['fresh'] |
'fresh' |
bounded_input (method)
Section titled “bounded_input (method)”FreshRecipientAdmissionTarget.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”FreshRecipientAdmissionTarget.immutable_fields() -> ContractValuerequested_identity (method)
Section titled “requested_identity (method)”FreshRecipientAdmissionTarget.requested_identity()Release source · Runtime guarantees · Capability guides
PreparedRecipientAdmission
Section titled “PreparedRecipientAdmission”from cayu.collaboration import PreparedRecipientAdmissionImmutable proposal authenticated only by a registered receiving owner.
Target families require explicit receiver qualification. The envelope carries evidence, never a portable execution permit or writer lease.
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 |
|---|---|---|
schema_version |
VersionOne |
1 |
receiver |
ObjectRef |
required |
recipient |
ParticipantRef |
required |
lifecycle_revision |
Generation |
required |
configuration_revision |
Generation |
required |
admission_generation |
Generation |
required |
target |
Annotated[FreshRecipientAdmissionTarget | ForkRecipientAdmissionTarget | ContinueRecipientAdmissionTarget, Field(discriminator='kind')] |
required |
execution_profile_json |
StrictStr |
required |
budget_binding_json |
StrictStr |
required |
bounded_input (method)
Section titled “bounded_input (method)”PreparedRecipientAdmission.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”PreparedRecipientAdmission.immutable_fields() -> ContractValueprofile_snapshot (method)
Section titled “profile_snapshot (method)”PreparedRecipientAdmission.profile_snapshot(value: str) -> strbudget_snapshot (method)
Section titled “budget_snapshot (method)”PreparedRecipientAdmission.budget_snapshot(value: str) -> strexact_recipient (method)
Section titled “exact_recipient (method)”PreparedRecipientAdmission.exact_recipient() -> PreparedRecipientAdmissionRelease source · Runtime guarantees · Capability guides
RecipientContinuationRequest
Section titled “RecipientContinuationRequest”from cayu.collaboration import RecipientContinuationRequestSelect one existing incarnation; neither a writer claim nor input append.
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 |
|---|---|---|
session_id |
Identifier |
required |
session_instance_id |
Identifier |
required |
participant |
ParticipantRef |
required |
bounded_input (method)
Section titled “bounded_input (method)”RecipientContinuationRequest.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RecipientContinuationRequest.immutable_fields() -> ContractValue