Skip to content

cayu.collaboration definitions

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 ClarificationCloseCommand

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
mode Literal['clarification_close'] 'clarification_close'
operation OperationRef required
expected RequestCommand required
question OperationRef required
question_sha256 Commitment required
kind Literal['cancelled', 'expired', 'superseded', 'request_terminal'] required
initiator InitiatorBinding required
ClarificationCloseCommand.bounded_input(value: object) -> Any
ClarificationCloseCommand.immutable_fields() -> ContractValue
ClarificationCloseCommand.exact_parent() -> ClarificationCloseCommand

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationCloseReceipt

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
command ClarificationCloseCommand required
decision ClarificationQuestionState required
event RequestEvent required
ClarificationCloseReceipt.bounded_input(value: object) -> Any
ClarificationCloseReceipt.immutable_fields() -> ContractValue
ClarificationCloseReceipt.exact_receipt() -> ClarificationCloseReceipt

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationDeliveryIntent

Immutable retry tuple; receiving authority is established separately.

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
operation OperationRef required
initiator InitiatorBinding required
question ClarificationQuestion required
reply ClarificationReply | None None
sender ParticipantRef required
recipient ParticipantRef required
export SessionExportRequest required
append PeerContentAppendRequest required
ClarificationDeliveryIntent.bounded_input(value: object) -> Any
ClarificationDeliveryIntent.immutable_fields() -> ContractValue
ClarificationDeliveryIntent.exact_source_and_target() -> ClarificationDeliveryIntent

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationDeliveryReceipt

Public handoff status, without source payload or private receiving intent.

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
operation OperationRef required
question OperationRef required
kind Literal['question', 'reply'] required
status Literal['pending', 'appended', 'excluded'] required
queue_id Identifier | None None
reason Identifier | None None
ClarificationDeliveryReceipt.bounded_input(value: object) -> Any
ClarificationDeliveryReceipt.immutable_fields() -> ContractValue
ClarificationDeliveryReceipt.coherent() -> ClarificationDeliveryReceipt
ClarificationDeliveryReceipt.from_record(record: ClarificationDeliveryRecord) -> ClarificationDeliveryReceipt

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationDeliveryRecord

Pending until positive append/exclusion readback, never exposure evidence.

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
mode Literal['clarification_delivery'] 'clarification_delivery'
intent ClarificationDeliveryIntent required
state Literal['pending', 'settled'] 'pending'
receipt PeerContentReceipt | None None
ClarificationDeliveryRecord.bounded_input(value: object) -> Any
ClarificationDeliveryRecord.immutable_fields() -> ContractValue
ClarificationDeliveryRecord.exact_receiving_decision() -> ClarificationDeliveryRecord

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationDeliveryRecovery

Expected complete delivery identity; never an append or disclosure grant.

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
kind Literal['clarification_delivery_recovery'] 'clarification_delivery_recovery'
operation OperationRef required
intent_sha256 Commitment required
ClarificationDeliveryRecovery.bounded_input(value: object) -> Any
ClarificationDeliveryRecovery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationDueQuestion

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
recovery ClarificationQuestionRecovery required
deadline_at_ms StrictInt Field(ge=1, le=2 ** 53 - 1)
ClarificationDueQuestion.bounded_input(value: object) -> Any
ClarificationDueQuestion.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationDueQuestionPage

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
items tuple[ClarificationDueQuestion, ...] Field(max_length=64)
next_cursor ClarificationDueCursor | None required
ClarificationDueQuestionPage.bounded_input(value: object) -> Any
ClarificationDueQuestionPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationExpiryReceipt

Decision settlement only, not provider/tool quiescence or delivery exclusion.

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
expected ClarificationExpiryRequest required
status Literal['expired'] 'expired'
event_sequence StrictInt Field(ge=1, le=2 ** 53 - 1)
expired_at_ms StrictInt Field(ge=1, le=2 ** 53 - 1)
ClarificationExpiryReceipt.bounded_input(value: object) -> Any
ClarificationExpiryReceipt.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationExpiryRequest

Stable maintenance operation; retries must preserve both exact identities.

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
operation OperationRef required
recovery ClarificationQuestionRecovery required
ClarificationExpiryRequest.bounded_input(value: object) -> Any
ClarificationExpiryRequest.immutable_fields() -> ContractValue
ClarificationExpiryRequest.coherent()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationOpenCommand

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
mode Literal['clarification_open'] 'clarification_open'
operation OperationRef required
expected RequestCommand required
expected_revision Generation required
question ClarificationQuestion required
ClarificationOpenCommand.bounded_input(value: object) -> Any
ClarificationOpenCommand.immutable_fields() -> ContractValue
ClarificationOpenCommand.exact_parent() -> ClarificationOpenCommand

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationOpenReceipt

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
command ClarificationOpenCommand required
decision ClarificationQuestionState required
event RequestEvent required
ClarificationOpenReceipt.bounded_input(value: object) -> Any
ClarificationOpenReceipt.immutable_fields() -> ContractValue
ClarificationOpenReceipt.exact_receipt() -> ClarificationOpenReceipt

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationPendingDelivery

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
recovery ClarificationDeliveryRecovery required
question OperationRef required
deadline_at_ms StrictInt Field(ge=1, le=2 ** 53 - 1)
ClarificationPendingDelivery.bounded_input(value: object) -> Any
ClarificationPendingDelivery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationPendingDeliveryPage

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
items tuple[ClarificationPendingDelivery, ...] Field(max_length=64)
next_cursor ClarificationDueCursor | None required
ClarificationPendingDeliveryPage.bounded_input(value: object) -> Any
ClarificationPendingDeliveryPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationPendingService

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
recovery ClarificationServiceRecovery required
question OperationRef required
deadline_at_ms StrictInt Field(ge=1, le=2 ** 53 - 1)
ClarificationPendingService.bounded_input(value: object) -> Any
ClarificationPendingService.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationPendingServicePage

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
items tuple[ClarificationPendingService, ...] Field(max_length=64)
next_cursor ClarificationDueCursor | None required
ClarificationPendingServicePage.bounded_input(value: object) -> Any
ClarificationPendingServicePage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationQuestionRecovery

Exact historical question identity, never source disclosure authority.

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
kind Literal['clarification_question_recovery'] 'clarification_question_recovery'
operation OperationRef required
question_sha256 Commitment required
request_sha256 Commitment required
ClarificationQuestionRecovery.bounded_input(value: object) -> Any
ClarificationQuestionRecovery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationQuestionState

Question decision, deliberately independent of delivery and service return.

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
question ClarificationQuestion required
opened_at_ms Millis required
state Literal['open', 'answered', 'superseded', 'cancelled', 'expired', 'request_terminal'] required
reply ClarificationReply | None None
input ClarificationInputRevision | None None
closed_at_ms Millis | None None
closure_operation OperationRef | None None
ClarificationQuestionState.bounded_input(value: object) -> Any
ClarificationQuestionState.immutable_fields() -> ContractValue
ClarificationQuestionState.coherent() -> ClarificationQuestionState

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationReplyAcceptance

Public election evidence, without executable admission/permit material.

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
operation OperationRef required
question OperationRef required
input_revision InputRevision required
input_sha256 Commitment required
event_id Identifier required
ClarificationReplyAcceptance.bounded_input(value: object) -> Any
ClarificationReplyAcceptance.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationReplyRequest

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
operation OperationRef required
initiator InitiatorBinding required
expected RequestCommand required
service ClarificationServiceRequest required
source SessionExportRequest required
production_stage_id Identifier required
expected_input_revision InputRevision required
expected_input_sha256 Commitment required
ClarificationReplyRequest.bounded_input(value: object) -> Any
ClarificationReplyRequest.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationServiceInspection

Bases: ClarificationPendingService.

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
recovery ClarificationServiceRecovery required
question OperationRef required
deadline_at_ms StrictInt Field(ge=1, le=2 ** 53 - 1)
state Literal['prepared', 'reserved', 'admitted', 'returned', 'excluded'] required
ClarificationServiceInspection.bounded_input(value: object) -> Any
ClarificationServiceInspection.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationServiceInspectionPage

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
items tuple[ClarificationServiceInspection, ...] Field(max_length=64)
next_cursor ClarificationDueCursor | None required
ClarificationServiceInspectionPage.bounded_input(value: object) -> Any
ClarificationServiceInspectionPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationServiceReceipt

Bounded status projection; private permit/admission material stays internal.

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
operation OperationRef required
question OperationRef required
state Literal['prepared', 'reserved', 'admitted', 'returned', 'excluded'] required
session_id Identifier required
session_instance_id Identifier required
invocation_id Identifier required
released_session_status ServiceReleasedSessionStatus | None None
ClarificationServiceReceipt.bounded_input(value: object) -> Any
ClarificationServiceReceipt.immutable_fields() -> ContractValue
ClarificationServiceReceipt.exact_return_report()
ClarificationServiceReceipt.from_record(record: TemporaryServiceRecord)

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationServiceRecovery

Exact retained dispatch commitment, not a reconstructed service instruction.

Recovery compares both commitments against the native and collaboration owners’ full immutable tuples. This selector only permits reconciliation; it cannot be submitted as a service request or used for admission. Session fields identify the original waiting ticket, not a side-session target selected by the authenticated dispatch.

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
kind Literal['clarification_service_recovery'] 'clarification_service_recovery'
operation OperationRef required
session_id Identifier required
session_instance_id Identifier required
selection_sha256 Commitment required
dispatch_sha256 Commitment required
ClarificationServiceRecovery.bounded_input(value: object) -> Any
ClarificationServiceRecovery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ClarificationServiceRequest

Exact host selection, not a permit, invocation or source disclosure grant.

The delivery fixes the existing target and its incarnation. Service never creates a target, injects raw peer input, or retries an unresolved dispatch.

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
operation OperationRef required
initiator InitiatorBinding required
delivery ClarificationDeliveryIntent required
ticket ContinuationTicket required
service_generation StrictInt Field(ge=1, le=MAX_CLARIFICATION_TURNS)
parent_service OperationRef | None required
instruction StrictStr Field(min_length=1, max_length=MAX_CLARIFICATION_TEXT_BYTES)
ClarificationServiceRequest.bounded_input(value: object) -> Any
ClarificationServiceRequest.immutable_fields() -> ContractValue
ClarificationServiceRequest.bounded_instruction(value)
ClarificationServiceRequest.exact_selection()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import CollaborationCapabilityUnavailable

The registered owner does not advertise the required complete contract.

Bases: ValueError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import CollaborationConflict

An operation key was reused with different expected material.

Bases: ValueError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import CollaborationContractError

Content-free rejection of malformed collaboration contract material.

Bases: ValueError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import CollaborationWaitLatchReceiver

Session continuation receiver backed by durable wait election state.

Bases: RetainedContinuationLatchReceiver.

async CollaborationWaitLatchReceiver.authenticate_continuation_latch(latch)
CollaborationWaitLatchReceiver.__init__(*, store, initialized, redactor, owners=None) -> None

authenticate_continuation_retirement (method)

Section titled “authenticate_continuation_retirement (method)”
async CollaborationWaitLatchReceiver.authenticate_continuation_retirement(wait, record)

Authenticate settlement from the exact durable wait, never caller receipts.

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import DiscoveredWait

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
recovery WaitRecovery required
revision Generation required
state WaitState required
delivery WaitDelivery required
DiscoveredWait.bounded_input(value: object) -> Any
DiscoveredWait.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerCleanupFinalized

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
mode Literal['producer_cleanup_finalized'] 'producer_cleanup_finalized'
operation OperationRef required
registration OperationRef required
cleanup OperationRef required
sequence Generation required
native_receipt NativeProducerCleanupReceipt required
delivery Literal['published', 'excluded'] required
ProducerCleanupFinalized.bounded_input(value: object) -> Any
ProducerCleanupFinalized.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerCompletionRecord

Accepted native production, separate from election, delivery and quiescence.

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
mode Literal['producer_completion'] 'producer_completion'
operation OperationRef required
output ProducerNativeOutput | ProducerNativeFailure required
native_commitment NativeCommitment required
sequence Generation required
recorded_at_ms Millis required
ProducerCompletionRecord.bounded_input(value: object) -> Any
ProducerCompletionRecord.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerDeliveryDestination

One finite intended delivery, not a queue entry or append authorization.

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
operation OperationRef required
recipient ParticipantRef required
attempt PeerDeliveryAttemptKey required
projector ObjectRef required
validator ObjectRef required
disclosure_policy ObjectRef required
mandate ObjectRef required
ProducerDeliveryDestination.bounded_input(value: object) -> Any
ProducerDeliveryDestination.immutable_fields() -> ContractValue
ProducerDeliveryDestination.exact_destination() -> ProducerDeliveryDestination

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerDeliveryRecord

Source obligation around one existing peer queue; not exposure or quiescence.

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
mode Literal['producer_delivery'] 'producer_delivery'
operation OperationRef required
registration OperationRef required
destination OperationRef required
export OperationRef required
outcome OperationRef required
source_receipt SessionExportReceipt required
append PeerContentAppendRequest required
sequence Generation required
receipt PeerContentReceipt | None None
acceptance OperationRef | None None
ProducerDeliveryRecord.bounded_input(value: object) -> Any
ProducerDeliveryRecord.immutable_fields() -> ContractValue
ProducerDeliveryRecord.exact_acceptance()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerDeliveryRecovery

Expected immutable registration; neither disclosure nor dispatch authority.

Bases: ProducerOutputRecovery.

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
registration OperationRef required
registration_commitment NativeCommitment required
destination OperationRef required
ProducerDeliveryRecovery.bounded_input(value: object) -> Any
ProducerDeliveryRecovery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerDeliveryStatus

No text, export receipt, execution authority or exposure claim.

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
recovery ProducerDeliveryRecovery required
operation OperationRef required
state Literal['pending', 'appended', 'excluded'] required
receipt_commitment NativeCommitment | None None
ProducerDeliveryStatus.bounded_input(value: object) -> Any
ProducerDeliveryStatus.immutable_fields() -> ContractValue
ProducerDeliveryStatus.exact_receiving_state()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerDestinationInspection

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
destination OperationRef required
export Literal['prepared', 'published', 'rejected'] | None required
delivery Literal['pending', 'appended', 'excluded'] | None required
export_cleanup Literal['released', 'retired', 'excluded'] | None None
ProducerDestinationInspection.bounded_input(value: object) -> Any
ProducerDestinationInspection.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerDispositionStatus

Closure servicing observation; no form claims effect quiescence or settlement.

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
registration OperationRef required
control OperationRef required
disposition Literal['stop_accepted', 'invocation_released'] required
native_stop NativeProducerStopReceipt | None None
native_release_commitment NativeCommitment | None None
ProducerDispositionStatus.bounded_input(value: object) -> Any
ProducerDispositionStatus.immutable_fields() -> ContractValue
ProducerDispositionStatus.exact_stop()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerExportCleanupStatus

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
registration OperationRef required
destination OperationRef required
export OperationRef | None required
closure OperationRef | None None
delivery OperationRef | None None
destination_exclusion OperationRef | None None
state Literal['excluded', 'retired', 'released'] required
native_commitment NativeCommitment | None None
exclusion_commitment NativeCommitment | None None
ProducerExportCleanupStatus.bounded_input(value: object) -> Any
ProducerExportCleanupStatus.immutable_fields() -> ContractValue
ProducerExportCleanupStatus.exact_basis()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerExportRecord

Frozen per-destination export intent, never a delivery or disclosure grant.

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
mode Literal['producer_export'] 'producer_export'
operation OperationRef required
registration OperationRef required
completion OperationRef required
destination OperationRef required
request SessionExportRequest required
initiator InitiatorBinding required
sequence Generation required
state Literal['prepared', 'published'] 'prepared'
publication OperationRef | None None
receipt_commitment NativeCommitment | None None
output_commitment NativeCommitment | None None
rejection OperationRef | None None
ProducerExportRecord.bounded_input(value: object) -> Any
ProducerExportRecord.immutable_fields() -> ContractValue
ProducerExportRecord.exact_publication()

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputAcceptanceReader

Pinned source namespace, receiving store and audience configured by the host.

The index locates evidence; it does not authenticate caller receipts. Both complete source registration and the exact native receiving attempt must match. This reader deliberately inherits unavailable execution settlement.

Bases: SessionExportAcceptanceReader.

ProducerOutputAcceptanceReader.owner() -> OwnerRef
async ProducerOutputAcceptanceReader.lookup(receipt: SessionExportReceipt) -> ExactLookup[SessionExportAcceptance]
async ProducerOutputAcceptanceReader.settlement(receipt: SessionExportReceipt, expected: PermitCommand) -> ExactLookup[ReceivingSettlementReceipt]

Resolve exact receiving settlement; acceptance alone is insufficient.

ProducerOutputAcceptanceReader.__init__(*, collaboration_store, session_store, namespace, audience, redactor=None)

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputInspection

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
recovery ProducerOutputRecovery required
state Literal['registered', 'launch_claimed', 'excluded'] required
completion OperationRef | None required
cleanup OperationRef | None required
cleanup_ack OperationRef | None required
exports tuple[OperationRef, ...] Field(max_length=MAX_OUTPUT_DESTINATIONS)
deliveries tuple[OperationRef, ...] Field(max_length=MAX_OUTPUT_DESTINATIONS)
exclusions tuple[OperationRef, ...] Field(max_length=MAX_OUTPUT_DESTINATIONS)
request_state Literal['open', 'answered', 'failed', 'declined', 'cancelled', 'expired'] required
completion_disposition Literal['answer', 'oversized', 'unsupported', 'empty', 'failed', 'stopped'] | None required
answer_destination OperationRef | None required
destinations tuple[ProducerDestinationInspection, ...] Field(min_length=1, max_length=MAX_OUTPUT_DESTINATIONS)
ProducerOutputInspection.bounded_input(value: object) -> Any
ProducerOutputInspection.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputLimits

Ceilings reserved before native execution; actual allocation is store-owned.

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
output_bytes Annotated[StrictInt, Field(ge=1, le=MAX_OUTPUT_BYTES)] required
progress_occurrences Annotated[StrictInt, Field(ge=0, le=MAX_OUTPUT_PROGRESS)] required
destinations Annotated[StrictInt, Field(ge=1, le=MAX_OUTPUT_DESTINATIONS)] required
deadline_at_ms Millis required
ProducerOutputLimits.bounded_input(value: object) -> Any
ProducerOutputLimits.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputProposal

Caller choices for inert preparation; no caller-supplied native authority.

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
operation OperationRef required
admission RequestAdmissionCommand required
binding_incarnation Identifier required
limits ProducerOutputLimits required
destinations tuple[ProducerDeliveryDestination, ...] Field(min_length=1, max_length=MAX_OUTPUT_DESTINATIONS)
ProducerOutputProposal.bounded_input(value: object) -> Any
ProducerOutputProposal.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputRecord

Initial durable responsibility; no native launch has yet been accepted.

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
mode Literal['producer_output_record'] 'producer_output_record'
command ProducerOutputRegistration required
event ProducerRegistrationEvent required
permit PermitCommand required
state Literal['registered', 'launch_claimed', 'excluded'] 'registered'
launch ProducerLaunchDecision | None None
cleanup ProducerCleanupRecord | ProducerAdmittedCleanup | None None
cleanup_ack OperationRef | None None
completion OperationRef | None None
exports tuple[OperationRef, ...] Field(default=(), max_length=MAX_OUTPUT_DESTINATIONS)
deliveries tuple[OperationRef, ...] Field(default=(), max_length=MAX_OUTPUT_DESTINATIONS)
exclusions tuple[OperationRef, ...] Field(default=(), max_length=MAX_OUTPUT_DESTINATIONS)
reserved_operations Counter required
reserved_events Counter required
reserved_bytes Counter required
ProducerOutputRecord.bounded_input(value: object) -> Any
ProducerOutputRecord.immutable_fields() -> ContractValue
ProducerOutputRecord.exact_registration() -> ProducerOutputRecord

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputRecovery

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
registration OperationRef required
registration_commitment NativeCommitment required
ProducerOutputRecovery.bounded_input(value: object) -> Any
ProducerOutputRecovery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerOutputRegistration

Complete proposed binding for one producer and one admitted request.

The registered owner must re-read admission, validate current launch authority, authenticate execution_commitment from native preparation, and reserve durable capacity. Neither this object nor an equal durable value authenticates callers.

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
mode Literal['producer_output_registration'] 'producer_output_registration'
operation OperationRef required
admission RequestAdmissionCommand required
initiator InitiatorBinding required
receiver ObjectRef required
binding_incarnation Identifier required
execution_key Identifier required
execution_commitment NativeCommitment required
publisher_generation Generation required
disposition Literal['stop'] required
limits ProducerOutputLimits required
destinations tuple[ProducerDeliveryDestination, ...] Field(min_length=1, max_length=MAX_OUTPUT_DESTINATIONS)
ProducerOutputRegistration.bounded_input(value: object) -> Any
ProducerOutputRegistration.immutable_fields() -> ContractValue
ProducerOutputRegistration.exact_admitted_binding() -> ProducerOutputRegistration

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerPendingOutput

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
recovery ProducerOutputRecovery required
position Counter required
destinations tuple[OperationRef, ...] Field(max_length=MAX_OUTPUT_DESTINATIONS)
ProducerPendingOutput.bounded_input(value: object) -> Any
ProducerPendingOutput.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerPendingPage

Cursor advances scanned permits, including unrelated responsibilities.

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
items tuple[ProducerPendingOutput, ...] Field(max_length=32)
next_cursor Counter | None None
ProducerPendingPage.bounded_input(value: object) -> Any
ProducerPendingPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerProgressOccurrence

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
operation OperationRef required
expected_revision Generation required
sequence Generation required
kind ProducerProgressKind required
ProducerProgressOccurrence.bounded_input(value: object) -> Any
ProducerProgressOccurrence.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import ProducerProgressReference

Exact frontier pointer; the complete receipt remains in the operation store.

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
mode Literal['producer_progress_reference'] 'producer_progress_reference'
operation OperationRef required
sequence Generation required
revision Generation required
kind ProducerProgressKind required
event_sequence Generation required
receipt_commitment NativeCommitment required
ProducerProgressReference.bounded_input(value: object) -> Any
ProducerProgressReference.immutable_fields() -> ContractValue
ProducerProgressReference.from_receipt(receipt, *, redactor)

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import RequestPlanningCursor

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
next_due_at_ms Millis required
operation OperationRef required
RequestPlanningCursor.bounded_input(value: object) -> Any
RequestPlanningCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import RequestPlanningEvent

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
id Identifier required
sequence Generation required
operation OperationRef required
plan OperationRef required
request RequestRef required
type PlanningEventType required
commitment Commitment required
participants tuple[ParticipantRef, ...] Field(min_length=1, max_length=2)
RequestPlanningEvent.bounded_input(value: object) -> Any
RequestPlanningEvent.immutable_fields() -> ContractValue
RequestPlanningEvent.coherent() -> RequestPlanningEvent

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import RequestPlanningPage

Bounded maintenance readback, not a lease or permission to execute.

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
records tuple[RequestPlanningRecord, ...] Field(max_length=MAX_REQUEST_PLANNING_PAGE)
next_cursor RequestPlanningCursor | None required
observed_at_ms Millis required
RequestPlanningPage.bounded_input(value: object) -> Any
RequestPlanningPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import RequestPlanningReceipt

Immutable retained evaluation intent, before any policy or foreign effect.

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
command RequestPlanningRequest required
policy ConfiguredRequestPlanningPolicy required
retained_at_ms Millis required
event RequestPlanningEvent required
RequestPlanningReceipt.bounded_input(value: object) -> Any
RequestPlanningReceipt.immutable_fields() -> ContractValue
RequestPlanningReceipt.coherent() -> RequestPlanningReceipt

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import RequestPlanningRecord

Business state and pending responsibility are deliberately independent.

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
receipt RequestPlanningReceipt required
revision Generation required
state PlanningState required
decision_commitment Commitment | None required
stage_count StrictInt Field(ge=0, le=MAX_REQUEST_PLANNING_STAGES)
pending_stages StrictInt Field(ge=0, le=MAX_REQUEST_PLANNING_STAGES)
pruned_stages StrictInt Field(default=0, ge=0, le=MAX_REQUEST_PLANNING_STAGES)
next_due_at_ms Millis required
event_sequences tuple[Generation, ...] Field(min_length=1, max_length=MAX_REQUEST_PLAN_EVENTS)
reserved_bytes StrictInt Field(ge=0, le=2 ** 53 - 1)
reserved_events StrictInt Field(ge=0, le=MAX_REQUEST_PLAN_EVENTS)
disposition RequestPlanningDisposition | None None
successor RequestPlanningSuccessor | None None
RequestPlanningRecord.bounded_input(value: object) -> Any
RequestPlanningRecord.immutable_fields() -> ContractValue
RequestPlanningRecord.decision() -> RequestPlanningDecision | None

The retained policy owns the complete immutable selected proposal.

RequestPlanningRecord.control() -> RequestPlanningControl | None

Reconstruct the full public expectation without duplicating it durably.

RequestPlanningRecord.coherent() -> RequestPlanningRecord

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import RequestPlanningSuccessor

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
request RequestPlanningRequest required
prerequisite RequestAdmissionReceipt | None required
RequestPlanningSuccessor.bounded_input(value: object) -> Any
RequestPlanningSuccessor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import SessionExportRequestReceivingOwner

Authenticate terminal session-export evidence for request settlement.

Bases: RequestReceivingOwner.

SessionExportRequestReceivingOwner.ref() -> ObjectRef
async SessionExportRequestReceivingOwner.acquire(command: RequestReceivingCommand, *, context)
async SessionExportRequestReceivingOwner.settlement(command, expected, *, context)
SessionExportRequestReceivingOwner.__init__(*, audience: OwnerRef, reader: SessionExportAcceptanceReader, redactor: SecretRedactor | None=None)

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import WaitDiscoveryCursor

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
operation OperationRef required
WaitDiscoveryCursor.bounded_input(value: object) -> Any
WaitDiscoveryCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import WaitDiscoveryPage

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
items tuple[DiscoveredWait, ...] Field(max_length=32)
next_cursor WaitDiscoveryCursor | None required
WaitDiscoveryPage.bounded_input(value: object) -> Any
WaitDiscoveryPage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

from cayu.collaboration import WaitRecovery

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
operation OperationRef required
registration_digest StrictStr Field(pattern='^[0-9a-f]{64}$')
WaitRecovery.bounded_input(value: object) -> Any
WaitRecovery.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides