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.
ClarificationCloseCommand
Section titled “ClarificationCloseCommand”from cayu.collaboration import ClarificationCloseCommandBases: 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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationCloseCommand.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationCloseCommand.immutable_fields() -> ContractValueexact_parent (method)
Section titled “exact_parent (method)”ClarificationCloseCommand.exact_parent() -> ClarificationCloseCommandRelease source · Runtime guarantees · Capability guides
ClarificationCloseReceipt
Section titled “ClarificationCloseReceipt”from cayu.collaboration import ClarificationCloseReceiptBases: 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 |
|---|---|---|
command |
ClarificationCloseCommand |
required |
decision |
ClarificationQuestionState |
required |
event |
RequestEvent |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationCloseReceipt.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationCloseReceipt.immutable_fields() -> ContractValueexact_receipt (method)
Section titled “exact_receipt (method)”ClarificationCloseReceipt.exact_receipt() -> ClarificationCloseReceiptRelease source · Runtime guarantees · Capability guides
ClarificationDeliveryIntent
Section titled “ClarificationDeliveryIntent”from cayu.collaboration import ClarificationDeliveryIntentImmutable retry tuple; receiving authority is established separately.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationDeliveryIntent.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationDeliveryIntent.immutable_fields() -> ContractValueexact_source_and_target (method)
Section titled “exact_source_and_target (method)”ClarificationDeliveryIntent.exact_source_and_target() -> ClarificationDeliveryIntentRelease source · Runtime guarantees · Capability guides
ClarificationDeliveryReceipt
Section titled “ClarificationDeliveryReceipt”from cayu.collaboration import ClarificationDeliveryReceiptPublic handoff status, without source payload or private receiving intent.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationDeliveryReceipt.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationDeliveryReceipt.immutable_fields() -> ContractValuecoherent (method)
Section titled “coherent (method)”ClarificationDeliveryReceipt.coherent() -> ClarificationDeliveryReceiptfrom_record (method)
Section titled “from_record (method)”ClarificationDeliveryReceipt.from_record(record: ClarificationDeliveryRecord) -> ClarificationDeliveryReceiptRelease source · Runtime guarantees · Capability guides
ClarificationDeliveryRecord
Section titled “ClarificationDeliveryRecord”from cayu.collaboration import ClarificationDeliveryRecordPending until positive append/exclusion readback, never exposure evidence.
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 |
|---|---|---|
mode |
Literal['clarification_delivery'] |
'clarification_delivery' |
intent |
ClarificationDeliveryIntent |
required |
state |
Literal['pending', 'settled'] |
'pending' |
receipt |
PeerContentReceipt | None |
None |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationDeliveryRecord.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationDeliveryRecord.immutable_fields() -> ContractValueexact_receiving_decision (method)
Section titled “exact_receiving_decision (method)”ClarificationDeliveryRecord.exact_receiving_decision() -> ClarificationDeliveryRecordRelease source · Runtime guarantees · Capability guides
ClarificationDeliveryRecovery
Section titled “ClarificationDeliveryRecovery”from cayu.collaboration import ClarificationDeliveryRecoveryExpected complete delivery identity; never an append or disclosure grant.
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['clarification_delivery_recovery'] |
'clarification_delivery_recovery' |
operation |
OperationRef |
required |
intent_sha256 |
Commitment |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationDeliveryRecovery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationDeliveryRecovery.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationDueQuestion
Section titled “ClarificationDueQuestion”from cayu.collaboration import ClarificationDueQuestionBases: 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 |
|---|---|---|
recovery |
ClarificationQuestionRecovery |
required |
deadline_at_ms |
StrictInt |
Field(ge=1, le=2 ** 53 - 1) |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationDueQuestion.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationDueQuestion.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationDueQuestionPage
Section titled “ClarificationDueQuestionPage”from cayu.collaboration import ClarificationDueQuestionPageBases: 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 |
|---|---|---|
items |
tuple[ClarificationDueQuestion, ...] |
Field(max_length=64) |
next_cursor |
ClarificationDueCursor | None |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationDueQuestionPage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationDueQuestionPage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationExpiryReceipt
Section titled “ClarificationExpiryReceipt”from cayu.collaboration import ClarificationExpiryReceiptDecision settlement only, not provider/tool quiescence or delivery exclusion.
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 |
|---|---|---|
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) |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationExpiryReceipt.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationExpiryReceipt.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationExpiryRequest
Section titled “ClarificationExpiryRequest”from cayu.collaboration import ClarificationExpiryRequestStable maintenance operation; retries must preserve both exact identities.
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 |
|---|---|---|
operation |
OperationRef |
required |
recovery |
ClarificationQuestionRecovery |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationExpiryRequest.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationExpiryRequest.immutable_fields() -> ContractValuecoherent (method)
Section titled “coherent (method)”ClarificationExpiryRequest.coherent()Release source · Runtime guarantees · Capability guides
ClarificationOpenCommand
Section titled “ClarificationOpenCommand”from cayu.collaboration import ClarificationOpenCommandBases: 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 |
|---|---|---|
mode |
Literal['clarification_open'] |
'clarification_open' |
operation |
OperationRef |
required |
expected |
RequestCommand |
required |
expected_revision |
Generation |
required |
question |
ClarificationQuestion |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationOpenCommand.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationOpenCommand.immutable_fields() -> ContractValueexact_parent (method)
Section titled “exact_parent (method)”ClarificationOpenCommand.exact_parent() -> ClarificationOpenCommandRelease source · Runtime guarantees · Capability guides
ClarificationOpenReceipt
Section titled “ClarificationOpenReceipt”from cayu.collaboration import ClarificationOpenReceiptBases: 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 |
|---|---|---|
command |
ClarificationOpenCommand |
required |
decision |
ClarificationQuestionState |
required |
event |
RequestEvent |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationOpenReceipt.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationOpenReceipt.immutable_fields() -> ContractValueexact_receipt (method)
Section titled “exact_receipt (method)”ClarificationOpenReceipt.exact_receipt() -> ClarificationOpenReceiptRelease source · Runtime guarantees · Capability guides
ClarificationPendingDelivery
Section titled “ClarificationPendingDelivery”from cayu.collaboration import ClarificationPendingDeliveryBases: 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 |
|---|---|---|
recovery |
ClarificationDeliveryRecovery |
required |
question |
OperationRef |
required |
deadline_at_ms |
StrictInt |
Field(ge=1, le=2 ** 53 - 1) |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationPendingDelivery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationPendingDelivery.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationPendingDeliveryPage
Section titled “ClarificationPendingDeliveryPage”from cayu.collaboration import ClarificationPendingDeliveryPageBases: 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 |
|---|---|---|
items |
tuple[ClarificationPendingDelivery, ...] |
Field(max_length=64) |
next_cursor |
ClarificationDueCursor | None |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationPendingDeliveryPage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationPendingDeliveryPage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationPendingService
Section titled “ClarificationPendingService”from cayu.collaboration import ClarificationPendingServiceBases: 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 |
|---|---|---|
recovery |
ClarificationServiceRecovery |
required |
question |
OperationRef |
required |
deadline_at_ms |
StrictInt |
Field(ge=1, le=2 ** 53 - 1) |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationPendingService.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationPendingService.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationPendingServicePage
Section titled “ClarificationPendingServicePage”from cayu.collaboration import ClarificationPendingServicePageBases: 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 |
|---|---|---|
items |
tuple[ClarificationPendingService, ...] |
Field(max_length=64) |
next_cursor |
ClarificationDueCursor | None |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationPendingServicePage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationPendingServicePage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationQuestionRecovery
Section titled “ClarificationQuestionRecovery”from cayu.collaboration import ClarificationQuestionRecoveryExact historical question identity, never source disclosure authority.
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['clarification_question_recovery'] |
'clarification_question_recovery' |
operation |
OperationRef |
required |
question_sha256 |
Commitment |
required |
request_sha256 |
Commitment |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationQuestionRecovery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationQuestionRecovery.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationQuestionState
Section titled “ClarificationQuestionState”from cayu.collaboration import ClarificationQuestionStateQuestion decision, deliberately independent of delivery and service return.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationQuestionState.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationQuestionState.immutable_fields() -> ContractValuecoherent (method)
Section titled “coherent (method)”ClarificationQuestionState.coherent() -> ClarificationQuestionStateRelease source · Runtime guarantees · Capability guides
ClarificationReplyAcceptance
Section titled “ClarificationReplyAcceptance”from cayu.collaboration import ClarificationReplyAcceptancePublic election evidence, without executable admission/permit material.
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 |
|---|---|---|
operation |
OperationRef |
required |
question |
OperationRef |
required |
input_revision |
InputRevision |
required |
input_sha256 |
Commitment |
required |
event_id |
Identifier |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationReplyAcceptance.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationReplyAcceptance.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationReplyRequest
Section titled “ClarificationReplyRequest”from cayu.collaboration import ClarificationReplyRequestBases: 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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationReplyRequest.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationReplyRequest.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationServiceInspection
Section titled “ClarificationServiceInspection”from cayu.collaboration import ClarificationServiceInspectionBases: ClarificationPendingService.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationServiceInspection.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationServiceInspection.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationServiceInspectionPage
Section titled “ClarificationServiceInspectionPage”from cayu.collaboration import ClarificationServiceInspectionPageBases: 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 |
|---|---|---|
items |
tuple[ClarificationServiceInspection, ...] |
Field(max_length=64) |
next_cursor |
ClarificationDueCursor | None |
required |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationServiceInspectionPage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationServiceInspectionPage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationServiceReceipt
Section titled “ClarificationServiceReceipt”from cayu.collaboration import ClarificationServiceReceiptBounded status projection; private permit/admission material stays internal.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationServiceReceipt.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationServiceReceipt.immutable_fields() -> ContractValueexact_return_report (method)
Section titled “exact_return_report (method)”ClarificationServiceReceipt.exact_return_report()from_record (method)
Section titled “from_record (method)”ClarificationServiceReceipt.from_record(record: TemporaryServiceRecord)Release source · Runtime guarantees · Capability guides
ClarificationServiceRecovery
Section titled “ClarificationServiceRecovery”from cayu.collaboration import ClarificationServiceRecoveryExact 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.
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['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 |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationServiceRecovery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationServiceRecovery.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ClarificationServiceRequest
Section titled “ClarificationServiceRequest”from cayu.collaboration import ClarificationServiceRequestExact 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.
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 |
|---|---|---|
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) |
bounded_input (method)
Section titled “bounded_input (method)”ClarificationServiceRequest.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ClarificationServiceRequest.immutable_fields() -> ContractValuebounded_instruction (method)
Section titled “bounded_instruction (method)”ClarificationServiceRequest.bounded_instruction(value)exact_selection (method)
Section titled “exact_selection (method)”ClarificationServiceRequest.exact_selection()Release source · Runtime guarantees · Capability guides
CollaborationCapabilityUnavailable
Section titled “CollaborationCapabilityUnavailable”from cayu.collaboration import CollaborationCapabilityUnavailableThe 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
CollaborationConflict
Section titled “CollaborationConflict”from cayu.collaboration import CollaborationConflictAn 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
CollaborationContractError
Section titled “CollaborationContractError”from cayu.collaboration import CollaborationContractErrorContent-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
CollaborationWaitLatchReceiver
Section titled “CollaborationWaitLatchReceiver”from cayu.collaboration import CollaborationWaitLatchReceiverSession continuation receiver backed by durable wait election state.
Bases: RetainedContinuationLatchReceiver.
authenticate_continuation_latch (method)
Section titled “authenticate_continuation_latch (method)”async CollaborationWaitLatchReceiver.authenticate_continuation_latch(latch)init (method)
Section titled “init (method)”CollaborationWaitLatchReceiver.__init__(*, store, initialized, redactor, owners=None) -> Noneauthenticate_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
DiscoveredWait
Section titled “DiscoveredWait”from cayu.collaboration import DiscoveredWaitBases: 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 |
|---|---|---|
recovery |
WaitRecovery |
required |
revision |
Generation |
required |
state |
WaitState |
required |
delivery |
WaitDelivery |
required |
bounded_input (method)
Section titled “bounded_input (method)”DiscoveredWait.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”DiscoveredWait.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerCleanupFinalized
Section titled “ProducerCleanupFinalized”from cayu.collaboration import ProducerCleanupFinalizedBases: 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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerCleanupFinalized.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerCleanupFinalized.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerCompletionRecord
Section titled “ProducerCompletionRecord”from cayu.collaboration import ProducerCompletionRecordAccepted native production, separate from election, delivery and quiescence.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerCompletionRecord.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerCompletionRecord.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerDeliveryDestination
Section titled “ProducerDeliveryDestination”from cayu.collaboration import ProducerDeliveryDestinationOne finite intended delivery, not a queue entry or append authorization.
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 |
|---|---|---|
operation |
OperationRef |
required |
recipient |
ParticipantRef |
required |
attempt |
PeerDeliveryAttemptKey |
required |
projector |
ObjectRef |
required |
validator |
ObjectRef |
required |
disclosure_policy |
ObjectRef |
required |
mandate |
ObjectRef |
required |
bounded_input (method)
Section titled “bounded_input (method)”ProducerDeliveryDestination.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerDeliveryDestination.immutable_fields() -> ContractValueexact_destination (method)
Section titled “exact_destination (method)”ProducerDeliveryDestination.exact_destination() -> ProducerDeliveryDestinationRelease source · Runtime guarantees · Capability guides
ProducerDeliveryRecord
Section titled “ProducerDeliveryRecord”from cayu.collaboration import ProducerDeliveryRecordSource obligation around one existing peer queue; not exposure or quiescence.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerDeliveryRecord.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerDeliveryRecord.immutable_fields() -> ContractValueexact_acceptance (method)
Section titled “exact_acceptance (method)”ProducerDeliveryRecord.exact_acceptance()Release source · Runtime guarantees · Capability guides
ProducerDeliveryRecovery
Section titled “ProducerDeliveryRecovery”from cayu.collaboration import ProducerDeliveryRecoveryExpected immutable registration; neither disclosure nor dispatch authority.
Bases: ProducerOutputRecovery.
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 |
|---|---|---|
registration |
OperationRef |
required |
registration_commitment |
NativeCommitment |
required |
destination |
OperationRef |
required |
bounded_input (method)
Section titled “bounded_input (method)”ProducerDeliveryRecovery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerDeliveryRecovery.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerDeliveryStatus
Section titled “ProducerDeliveryStatus”from cayu.collaboration import ProducerDeliveryStatusNo text, export receipt, execution authority or exposure claim.
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 |
|---|---|---|
recovery |
ProducerDeliveryRecovery |
required |
operation |
OperationRef |
required |
state |
Literal['pending', 'appended', 'excluded'] |
required |
receipt_commitment |
NativeCommitment | None |
None |
bounded_input (method)
Section titled “bounded_input (method)”ProducerDeliveryStatus.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerDeliveryStatus.immutable_fields() -> ContractValueexact_receiving_state (method)
Section titled “exact_receiving_state (method)”ProducerDeliveryStatus.exact_receiving_state()Release source · Runtime guarantees · Capability guides
ProducerDestinationInspection
Section titled “ProducerDestinationInspection”from cayu.collaboration import ProducerDestinationInspectionBases: 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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerDestinationInspection.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerDestinationInspection.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerDispositionStatus
Section titled “ProducerDispositionStatus”from cayu.collaboration import ProducerDispositionStatusClosure servicing observation; no form claims effect quiescence or settlement.
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 |
|---|---|---|
registration |
OperationRef |
required |
control |
OperationRef |
required |
disposition |
Literal['stop_accepted', 'invocation_released'] |
required |
native_stop |
NativeProducerStopReceipt | None |
None |
native_release_commitment |
NativeCommitment | None |
None |
bounded_input (method)
Section titled “bounded_input (method)”ProducerDispositionStatus.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerDispositionStatus.immutable_fields() -> ContractValueexact_stop (method)
Section titled “exact_stop (method)”ProducerDispositionStatus.exact_stop()Release source · Runtime guarantees · Capability guides
ProducerExportCleanupStatus
Section titled “ProducerExportCleanupStatus”from cayu.collaboration import ProducerExportCleanupStatusBases: 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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerExportCleanupStatus.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerExportCleanupStatus.immutable_fields() -> ContractValueexact_basis (method)
Section titled “exact_basis (method)”ProducerExportCleanupStatus.exact_basis()Release source · Runtime guarantees · Capability guides
ProducerExportRecord
Section titled “ProducerExportRecord”from cayu.collaboration import ProducerExportRecordFrozen per-destination export intent, never a delivery or disclosure grant.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerExportRecord.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerExportRecord.immutable_fields() -> ContractValueexact_publication (method)
Section titled “exact_publication (method)”ProducerExportRecord.exact_publication()Release source · Runtime guarantees · Capability guides
ProducerOutputAcceptanceReader
Section titled “ProducerOutputAcceptanceReader”from cayu.collaboration import ProducerOutputAcceptanceReaderPinned 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.
owner (property)
Section titled “owner (property)”ProducerOutputAcceptanceReader.owner() -> OwnerReflookup (method)
Section titled “lookup (method)”async ProducerOutputAcceptanceReader.lookup(receipt: SessionExportReceipt) -> ExactLookup[SessionExportAcceptance]settlement (method)
Section titled “settlement (method)”async ProducerOutputAcceptanceReader.settlement(receipt: SessionExportReceipt, expected: PermitCommand) -> ExactLookup[ReceivingSettlementReceipt]Resolve exact receiving settlement; acceptance alone is insufficient.
init (method)
Section titled “init (method)”ProducerOutputAcceptanceReader.__init__(*, collaboration_store, session_store, namespace, audience, redactor=None)Release source · Runtime guarantees · Capability guides
ProducerOutputInspection
Section titled “ProducerOutputInspection”from cayu.collaboration import ProducerOutputInspectionBases: 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 |
|---|---|---|
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) |
bounded_input (method)
Section titled “bounded_input (method)”ProducerOutputInspection.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerOutputInspection.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerOutputLimits
Section titled “ProducerOutputLimits”from cayu.collaboration import ProducerOutputLimitsCeilings reserved before native execution; actual allocation is store-owned.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerOutputLimits.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerOutputLimits.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerOutputProposal
Section titled “ProducerOutputProposal”from cayu.collaboration import ProducerOutputProposalCaller choices for inert preparation; no caller-supplied native authority.
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 |
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) |
bounded_input (method)
Section titled “bounded_input (method)”ProducerOutputProposal.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerOutputProposal.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerOutputRecord
Section titled “ProducerOutputRecord”from cayu.collaboration import ProducerOutputRecordInitial durable responsibility; no native launch has yet been accepted.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerOutputRecord.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerOutputRecord.immutable_fields() -> ContractValueexact_registration (method)
Section titled “exact_registration (method)”ProducerOutputRecord.exact_registration() -> ProducerOutputRecordRelease source · Runtime guarantees · Capability guides
ProducerOutputRecovery
Section titled “ProducerOutputRecovery”from cayu.collaboration import ProducerOutputRecoveryBases: 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 |
|---|---|---|
registration |
OperationRef |
required |
registration_commitment |
NativeCommitment |
required |
bounded_input (method)
Section titled “bounded_input (method)”ProducerOutputRecovery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerOutputRecovery.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerOutputRegistration
Section titled “ProducerOutputRegistration”from cayu.collaboration import ProducerOutputRegistrationComplete 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.
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 |
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) |
bounded_input (method)
Section titled “bounded_input (method)”ProducerOutputRegistration.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerOutputRegistration.immutable_fields() -> ContractValueexact_admitted_binding (method)
Section titled “exact_admitted_binding (method)”ProducerOutputRegistration.exact_admitted_binding() -> ProducerOutputRegistrationRelease source · Runtime guarantees · Capability guides
ProducerPendingOutput
Section titled “ProducerPendingOutput”from cayu.collaboration import ProducerPendingOutputBases: 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 |
|---|---|---|
recovery |
ProducerOutputRecovery |
required |
position |
Counter |
required |
destinations |
tuple[OperationRef, ...] |
Field(max_length=MAX_OUTPUT_DESTINATIONS) |
bounded_input (method)
Section titled “bounded_input (method)”ProducerPendingOutput.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerPendingOutput.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerPendingPage
Section titled “ProducerPendingPage”from cayu.collaboration import ProducerPendingPageCursor advances scanned permits, including unrelated responsibilities.
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 |
|---|---|---|
items |
tuple[ProducerPendingOutput, ...] |
Field(max_length=32) |
next_cursor |
Counter | None |
None |
bounded_input (method)
Section titled “bounded_input (method)”ProducerPendingPage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerPendingPage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerProgressOccurrence
Section titled “ProducerProgressOccurrence”from cayu.collaboration import ProducerProgressOccurrenceBases: 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 |
|---|---|---|
operation |
OperationRef |
required |
expected_revision |
Generation |
required |
sequence |
Generation |
required |
kind |
ProducerProgressKind |
required |
bounded_input (method)
Section titled “bounded_input (method)”ProducerProgressOccurrence.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerProgressOccurrence.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
ProducerProgressReference
Section titled “ProducerProgressReference”from cayu.collaboration import ProducerProgressReferenceExact frontier pointer; the complete receipt remains in the operation store.
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 |
|---|---|---|
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 |
bounded_input (method)
Section titled “bounded_input (method)”ProducerProgressReference.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”ProducerProgressReference.immutable_fields() -> ContractValuefrom_receipt (method)
Section titled “from_receipt (method)”ProducerProgressReference.from_receipt(receipt, *, redactor)Release source · Runtime guarantees · Capability guides
RequestPlanningCursor
Section titled “RequestPlanningCursor”from cayu.collaboration import RequestPlanningCursorBases: 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 |
|---|---|---|
next_due_at_ms |
Millis |
required |
operation |
OperationRef |
required |
bounded_input (method)
Section titled “bounded_input (method)”RequestPlanningCursor.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RequestPlanningCursor.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
RequestPlanningEvent
Section titled “RequestPlanningEvent”from cayu.collaboration import RequestPlanningEventBases: 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 |
|---|---|---|
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) |
bounded_input (method)
Section titled “bounded_input (method)”RequestPlanningEvent.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RequestPlanningEvent.immutable_fields() -> ContractValuecoherent (method)
Section titled “coherent (method)”RequestPlanningEvent.coherent() -> RequestPlanningEventRelease source · Runtime guarantees · Capability guides
RequestPlanningPage
Section titled “RequestPlanningPage”from cayu.collaboration import RequestPlanningPageBounded maintenance readback, not a lease or permission to execute.
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 |
|---|---|---|
records |
tuple[RequestPlanningRecord, ...] |
Field(max_length=MAX_REQUEST_PLANNING_PAGE) |
next_cursor |
RequestPlanningCursor | None |
required |
observed_at_ms |
Millis |
required |
bounded_input (method)
Section titled “bounded_input (method)”RequestPlanningPage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RequestPlanningPage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
RequestPlanningReceipt
Section titled “RequestPlanningReceipt”from cayu.collaboration import RequestPlanningReceiptImmutable retained evaluation intent, before any policy or foreign effect.
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 |
|---|---|---|
command |
RequestPlanningRequest |
required |
policy |
ConfiguredRequestPlanningPolicy |
required |
retained_at_ms |
Millis |
required |
event |
RequestPlanningEvent |
required |
bounded_input (method)
Section titled “bounded_input (method)”RequestPlanningReceipt.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RequestPlanningReceipt.immutable_fields() -> ContractValuecoherent (method)
Section titled “coherent (method)”RequestPlanningReceipt.coherent() -> RequestPlanningReceiptRelease source · Runtime guarantees · Capability guides
RequestPlanningRecord
Section titled “RequestPlanningRecord”from cayu.collaboration import RequestPlanningRecordBusiness state and pending responsibility are deliberately independent.
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 |
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 |
bounded_input (method)
Section titled “bounded_input (method)”RequestPlanningRecord.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RequestPlanningRecord.immutable_fields() -> ContractValuedecision (property)
Section titled “decision (property)”RequestPlanningRecord.decision() -> RequestPlanningDecision | NoneThe retained policy owns the complete immutable selected proposal.
control (property)
Section titled “control (property)”RequestPlanningRecord.control() -> RequestPlanningControl | NoneReconstruct the full public expectation without duplicating it durably.
coherent (method)
Section titled “coherent (method)”RequestPlanningRecord.coherent() -> RequestPlanningRecordRelease source · Runtime guarantees · Capability guides
RequestPlanningSuccessor
Section titled “RequestPlanningSuccessor”from cayu.collaboration import RequestPlanningSuccessorBases: 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 |
|---|---|---|
request |
RequestPlanningRequest |
required |
prerequisite |
RequestAdmissionReceipt | None |
required |
bounded_input (method)
Section titled “bounded_input (method)”RequestPlanningSuccessor.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”RequestPlanningSuccessor.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
SessionExportRequestReceivingOwner
Section titled “SessionExportRequestReceivingOwner”from cayu.collaboration import SessionExportRequestReceivingOwnerAuthenticate terminal session-export evidence for request settlement.
Bases: RequestReceivingOwner.
ref (property)
Section titled “ref (property)”SessionExportRequestReceivingOwner.ref() -> ObjectRefacquire (method)
Section titled “acquire (method)”async SessionExportRequestReceivingOwner.acquire(command: RequestReceivingCommand, *, context)settlement (method)
Section titled “settlement (method)”async SessionExportRequestReceivingOwner.settlement(command, expected, *, context)init (method)
Section titled “init (method)”SessionExportRequestReceivingOwner.__init__(*, audience: OwnerRef, reader: SessionExportAcceptanceReader, redactor: SecretRedactor | None=None)Release source · Runtime guarantees · Capability guides
WaitDiscoveryCursor
Section titled “WaitDiscoveryCursor”from cayu.collaboration import WaitDiscoveryCursorBases: 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 |
|---|---|---|
operation |
OperationRef |
required |
bounded_input (method)
Section titled “bounded_input (method)”WaitDiscoveryCursor.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”WaitDiscoveryCursor.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
WaitDiscoveryPage
Section titled “WaitDiscoveryPage”from cayu.collaboration import WaitDiscoveryPageBases: 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 |
|---|---|---|
items |
tuple[DiscoveredWait, ...] |
Field(max_length=32) |
next_cursor |
WaitDiscoveryCursor | None |
required |
bounded_input (method)
Section titled “bounded_input (method)”WaitDiscoveryPage.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”WaitDiscoveryPage.immutable_fields() -> ContractValueRelease source · Runtime guarantees · Capability guides
WaitRecovery
Section titled “WaitRecovery”from cayu.collaboration import WaitRecoveryBases: 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 |
|---|---|---|
operation |
OperationRef |
required |
registration_digest |
StrictStr |
Field(pattern='^[0-9a-f]{64}$') |
bounded_input (method)
Section titled “bounded_input (method)”WaitRecovery.bounded_input(value: object) -> Anyimmutable_fields (method)
Section titled “immutable_fields (method)”WaitRecovery.immutable_fields() -> ContractValue