Skip to content

cayu.collaboration.recipient_preparation

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.

from cayu.collaboration import ForkRecipientCreationPreparation

Bases: MaterialRecipientCreationPreparation.

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
base FreshRecipientPreparation required
blueprint_commitment NativeCommitment required
creation SessionCreationTarget required
selection ForkRetainedSelection required
resources tuple[ResourceMaterialReference, ...] Field(default=(), max_length=32)
ForkRecipientCreationPreparation.bounded_input(value: object) -> Any
ForkRecipientCreationPreparation.immutable_fields() -> ContractValue
ForkRecipientCreationPreparation.receiver()
ForkRecipientCreationPreparation.execution_profile_json()

historical_definition_commitment (property)

Section titled “historical_definition_commitment (property)”
ForkRecipientCreationPreparation.historical_definition_commitment()
ForkRecipientCreationPreparation.budget_binding_json()
ForkRecipientCreationPreparation.coherent()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ForkRecipientPreparation

Frozen base preflight and exact view admission, before acquiring history.

The base’s unadmitted creation proposal freezes request/profile/definition and sponsor data. Its resource-free creation permit MUST NOT be registered for this FORK. The material-bound target is resolved and durably retained separately after native selection/adoption, before child creation.

Bases: ContractValue.

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
base FreshRecipientPreparation required
view ContextViewSelectionTarget required
ForkRecipientPreparation.bounded_input(value: object) -> Any
ForkRecipientPreparation.immutable_fields() -> ContractValue
ForkRecipientPreparation.coherent()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import FreshRecipientPreparation

Exact future creation, pinned native profile/definition and sponsor.

SessionStore has not assigned an incarnation. The creation operation is the identity of this proposal; a requested public ID is never substituted for it.

Bases: ContractValue.

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
creation SessionCreationTarget required
request_json StrictStr required
execution_profile_json StrictStr required
historical_definition_commitment NativeCommitment required
budget_binding_json StrictStr required
FreshRecipientPreparation.bounded_input(value: object) -> Any
FreshRecipientPreparation.immutable_fields() -> ContractValue
FreshRecipientPreparation.request_snapshot(value: str) -> str
FreshRecipientPreparation.profile_snapshot(value: str) -> str
FreshRecipientPreparation.budget_snapshot(value: str) -> str
FreshRecipientPreparation.creation_request() -> RecipientSessionCreationRequest
FreshRecipientPreparation.coherent() -> FreshRecipientPreparation

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ResourceRecipientCreationPreparation

FRESH creation with authenticated material, but no inherited history.

Bases: MaterialRecipientCreationPreparation.

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
base FreshRecipientPreparation required
blueprint_commitment NativeCommitment required
creation SessionCreationTarget required
selection None None
resources tuple[ResourceMaterialReference, ...] Field(min_length=1, max_length=32)
ResourceRecipientCreationPreparation.bounded_input(value: object) -> Any
ResourceRecipientCreationPreparation.immutable_fields() -> ContractValue
ResourceRecipientCreationPreparation.receiver()
ResourceRecipientCreationPreparation.execution_profile_json()

historical_definition_commitment (property)

Section titled “historical_definition_commitment (property)”
ResourceRecipientCreationPreparation.historical_definition_commitment()
ResourceRecipientCreationPreparation.budget_binding_json()
ResourceRecipientCreationPreparation.coherent()

Release source · Runtime guarantees · Capability guides