cayu.collaboration.requests

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.

CollaborationRequest

from cayu.collaboration import CollaborationRequest

Bases: ContractValue.

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
kind	Literal['question', 'contribution']	required
sender	ParticipantRef	required
target	ParticipantRef | RequestAlias	required
content	str	Field(max_length=8192)
inputs	tuple[ObjectRef, ...]	Field(max_length=32)
context_hint	ObjectRef | None	required
delivery_contract	ObjectRef	required
output_contract	ObjectRef | None	required
independence_policy	ObjectRef	required
disclosure_policy	ObjectRef	required
ttl_ms	Millis	required
cancellation	Literal['detach', 'stop']	required

bounded_input (method)

CollaborationRequest.bounded_input(value: object) -> Any

immutable_fields (method)

CollaborationRequest.immutable_fields() -> ContractValue

exact_intent (method)

CollaborationRequest.exact_intent() -> CollaborationRequest

Release source · Runtime guarantees · Capability guides

ProducerProgressCommand

from cayu.collaboration import ProducerProgressCommand

Owner-produced native milestone, distinct from a caller’s export receipt.

Bases: RequestProgressCommand.

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
mode	Literal['request_progress']	'request_progress'
expected	RequestCommand	required
expected_revision	Generation	required
admission_generation	Generation	required
publisher	InitiatorBinding	required
sequence	Generation	required
kind	Literal['started', 'prepared', 'producing', 'published']	required
commitment	Identifier	required
source_receipt	SessionExportReceipt | None	None
producer	OperationRef	required
evidence	ProducerProgressEvidence	required

bounded_input (method)

ProducerProgressCommand.bounded_input(value: object) -> Any

immutable_fields (method)

ProducerProgressCommand.immutable_fields() -> ContractValue

exact_namespace (method)

ProducerProgressCommand.exact_namespace() -> RequestProgressCommand

native_progress (method)

ProducerProgressCommand.native_progress()

Release source · Runtime guarantees · Capability guides

RequestAdmissionCommand

from cayu.collaboration import RequestAdmissionCommand

Authenticated receiving-owner admission decision.

Bases: ContractValue.

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
mode	Literal['request_admission']	'request_admission'
expected	RequestCommand	required
expected_revision	Generation	required
expected_input_revision	Annotated[StrictInt, Field(ge=0, le=MAX_REQUEST_CLARIFICATIONS)]	required
expected_input_sha256	Annotated[StrictStr, Field(pattern='^[0-9a-f]{64}$')]	required
generation	Generation	required
decision	AdmissionDecision	required
proposal_commitment	Identifier | None	None
source_export	SessionExportRef | None	None
source_receipt	SessionExportReceipt | None	None
evidence	tuple[ObjectRef, ...]	Field(max_length=32)
initiator	InitiatorBinding	required
prepared	PreparedRecipientAdmission | None	None

bounded_input (method)

RequestAdmissionCommand.bounded_input(value: object) -> Any

immutable_fields (method)

RequestAdmissionCommand.immutable_fields() -> ContractValue

exact_admission (method)

RequestAdmissionCommand.exact_admission() -> RequestAdmissionCommand

Release source · Runtime guarantees · Capability guides

RequestAdmissionReceipt

from cayu.collaboration import RequestAdmissionReceipt

Bases: ContractValue.

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	RequestAdmissionCommand	required
state	AdmissionState	required
revision	Generation	required
decided_at_ms	Millis	required
event	RequestEvent	required
admission_permit	PermitReceipt | None	None

bounded_input (method)

RequestAdmissionReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

RequestAdmissionReceipt.immutable_fields() -> ContractValue

exact_receipt (method)

RequestAdmissionReceipt.exact_receipt() -> RequestAdmissionReceipt

Release source · Runtime guarantees · Capability guides

RequestAlias

from cayu.collaboration import RequestAlias

Original addressing intent, resolved only during first acceptance.

Bases: ContractValue.

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
owner	OwnerRef	required
alias	Identifier	required

bounded_input (method)

RequestAlias.bounded_input(value: object) -> Any

immutable_fields (method)

RequestAlias.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestCommand

from cayu.collaboration import RequestCommand

Bases: ExpectedOperation[RequestIntent].

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
kind	Literal['question', 'contribution']	required
schema_version	VersionOne	1
mode	Literal['request']	'request'
source	OwnerRef	required
destination	OwnerRef	required
initiator	InitiatorBinding	required
receipt_stage	Literal['accepted']	'accepted'
intent	IntentT	required

bounded_input (method)

RequestCommand.bounded_input(value: object) -> Any

immutable_fields (method)

RequestCommand.immutable_fields() -> ContractValue

operation_scope (method)

RequestCommand.operation_scope() -> ExpectedOperation[IntentT]

exact_selection (method)

RequestCommand.exact_selection() -> RequestCommand

Release source · Runtime guarantees · Capability guides

RequestControl

from cayu.collaboration import RequestControl

Bases: ContractValue.

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	RequestCommand	required
expected_revision	Generation	required
kind	Literal['cancel', 'expire']	required
source_receipt	SessionExportReceipt | None	None

bounded_input (method)

RequestControl.bounded_input(value: object) -> Any

immutable_fields (method)

RequestControl.immutable_fields() -> ContractValue

separate_control (method)

RequestControl.separate_control() -> RequestControl

Release source · Runtime guarantees · Capability guides

RequestControlCommand

from cayu.collaboration import RequestControlCommand

Bases: ExpectedOperation[RequestControl].

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
kind	Literal['cancel', 'expire']	required
schema_version	VersionOne	1
mode	Literal['request_control']	'request_control'
source	OwnerRef	required
destination	OwnerRef	required
initiator	InitiatorBinding	required
receipt_stage	Literal['elected']	'elected'
intent	IntentT	required

bounded_input (method)

RequestControlCommand.bounded_input(value: object) -> Any

immutable_fields (method)

RequestControlCommand.immutable_fields() -> ContractValue

operation_scope (method)

RequestControlCommand.operation_scope() -> ExpectedOperation[IntentT]

exact_control (method)

RequestControlCommand.exact_control() -> RequestControlCommand

Release source · Runtime guarantees · Capability guides

RequestControlReceipt

from cayu.collaboration import RequestControlReceipt

Bases: ContractValue.

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	RequestControlCommand	required
state	Literal['cancelled', 'expired']	required
revision	Generation	required
elected_at_ms	Millis	required
event	RequestEvent	required

bounded_input (method)

RequestControlReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

RequestControlReceipt.immutable_fields() -> ContractValue

exact_election (method)

RequestControlReceipt.exact_election() -> RequestControlReceipt

Release source · Runtime guarantees · Capability guides

RequestDueCursor

from cayu.collaboration import RequestDueCursor

Position for current due inspection, not an observation or history pin.

Bases: ContractValue.

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
after	Counter	required

bounded_input (method)

RequestDueCursor.bounded_input(value: object) -> Any

immutable_fields (method)

RequestDueCursor.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestDuePage

from cayu.collaboration import RequestDuePage

Bases: ContractValue.

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[RequestSnapshot, ...]	Field(max_length=64)
next_cursor	RequestDueCursor | None	required
observed_at_ms	Millis	required

bounded_input (method)

RequestDuePage.bounded_input(value: object) -> Any

immutable_fields (method)

RequestDuePage.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestEvent

from cayu.collaboration import RequestEvent

Bases: ContractValue.

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
request	RequestRef	required
type	Literal['request_accepted', 'request_admission', 'request_progress', 'request_answered', 'request_failed', 'request_declined', 'request_cancelled', 'request_expired', 'request_observation_registered', 'clarification_opened', 'clarification_replied', 'clarification_closed']	required
participants	tuple[ParticipantRef, ...]	Field(min_length=1, max_length=2)

bounded_input (method)

RequestEvent.bounded_input(value: object) -> Any

immutable_fields (method)

RequestEvent.immutable_fields() -> ContractValue

scope_matches (method)

RequestEvent.scope_matches() -> RequestEvent

Release source · Runtime guarantees · Capability guides

RequestIntent

from cayu.collaboration import RequestIntent

Bases: ContractValue.

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	CollaborationRequest	required
selection	RequestSelection	required
limits	CollaborationLimits	required
authority	MandateResolution	required

bounded_input (method)

RequestIntent.bounded_input(value: object) -> Any

immutable_fields (method)

RequestIntent.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestObservation

from cayu.collaboration import RequestObservation

Finite pull observation registration and its durable coverage frontier.

Bases: ContractValue.

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
key	Identifier	required
filter_commitment	Identifier	required
projection_commitment	Identifier	required
after_sequence	Counter	required
coverage_sequence	Counter	required
revision	Generation	required
retention_until_ms	Millis | None	None

bounded_input (method)

RequestObservation.bounded_input(value: object) -> Any

immutable_fields (method)

RequestObservation.immutable_fields() -> ContractValue

valid_frontier (method)

RequestObservation.valid_frontier() -> RequestObservation

Release source · Runtime guarantees · Capability guides

RequestObservationPage

from cayu.collaboration import RequestObservationPage

Bounded source-owned readback at a current transactional frontier.

Registration is immutable; each read reconciles coverage with publication.

Bases: ContractValue.

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	RequestObservationReceipt	required
events	tuple[RequestEvent, ...]	Field(max_length=64)
coverage_sequence	Counter	required
complete	bool	required

bounded_input (method)

RequestObservationPage.bounded_input(value: object) -> Any

immutable_fields (method)

RequestObservationPage.immutable_fields() -> ContractValue

exact_page (method)

RequestObservationPage.exact_page() -> RequestObservationPage

Release source · Runtime guarantees · Capability guides

RequestObservationReceipt

from cayu.collaboration import RequestObservationReceipt

Bases: ContractValue.

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['request_observation']	'request_observation'
operation	OperationRef	required
expected	RequestCommand	required
intent	RequestObservation	required
initiator	InitiatorBinding	required
request	RequestRef	required
observation	RequestObservation	required
event	RequestEvent	required

bounded_input (method)

RequestObservationReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

RequestObservationReceipt.immutable_fields() -> ContractValue

exact_receipt (method)

RequestObservationReceipt.exact_receipt() -> RequestObservationReceipt

Release source · Runtime guarantees · Capability guides

RequestOutcomeCommand

from cayu.collaboration import RequestOutcomeCommand

Authenticated answer/failure/decline election request.

Bases: ContractValue.

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
mode	Literal['request_outcome']	'request_outcome'
expected	RequestCommand	required
expected_revision	Generation	required
outcome	RequestOutcomeKind	required
commitment	Identifier | None	None
source_receipt	SessionExportReceipt | None	None
initiator	InitiatorBinding	required

bounded_input (method)

RequestOutcomeCommand.bounded_input(value: object) -> Any

immutable_fields (method)

RequestOutcomeCommand.immutable_fields() -> ContractValue

exact_outcome (method)

RequestOutcomeCommand.exact_outcome() -> RequestOutcomeCommand

Release source · Runtime guarantees · Capability guides

RequestOutcomeReceipt

from cayu.collaboration import RequestOutcomeReceipt

Bases: ContractValue.

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	RequestOutcomeCommand | ProducerOutcomeCommand	required
revision	Generation	required
elected_at_ms	Millis	required
event	RequestEvent	required

bounded_input (method)

RequestOutcomeReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

RequestOutcomeReceipt.immutable_fields() -> ContractValue

exact_receipt (method)

RequestOutcomeReceipt.exact_receipt() -> RequestOutcomeReceipt

Release source · Runtime guarantees · Capability guides

RequestProgressCommand

from cayu.collaboration import RequestProgressCommand

One authenticated, idempotent producer progress occurrence.

Bases: ContractValue.

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
mode	Literal['request_progress']	'request_progress'
expected	RequestCommand	required
expected_revision	Generation	required
admission_generation	Generation	required
publisher	InitiatorBinding	required
sequence	Generation	required
kind	Literal['started', 'prepared', 'producing', 'published']	required
commitment	Identifier	required
source_receipt	SessionExportReceipt | None	None

bounded_input (method)

RequestProgressCommand.bounded_input(value: object) -> Any

immutable_fields (method)

RequestProgressCommand.immutable_fields() -> ContractValue

exact_namespace (method)

RequestProgressCommand.exact_namespace() -> RequestProgressCommand

Release source · Runtime guarantees · Capability guides

RequestProgressReceipt

from cayu.collaboration import RequestProgressReceipt

Bases: ContractValue.

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	ProducerProgressCommand | RequestProgressCommand	required
revision	Generation	required
event	RequestEvent	required

bounded_input (method)

RequestProgressReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

RequestProgressReceipt.immutable_fields() -> ContractValue

exact_receipt (method)

RequestProgressReceipt.exact_receipt() -> RequestProgressReceipt

Release source · Runtime guarantees · Capability guides

RequestReceipt

from cayu.collaboration import RequestReceipt

Bases: ContractValue.

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	RequestCommand	required
event	RequestEvent	required

bounded_input (method)

RequestReceipt.bounded_input(value: object) -> Any

immutable_fields (method)

RequestReceipt.immutable_fields() -> ContractValue

exact_receipt (method)

RequestReceipt.exact_receipt() -> RequestReceipt

Release source · Runtime guarantees · Capability guides

RequestRef

from cayu.collaboration import RequestRef

Bases: ContractValue.

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
owner	OwnerRef	required
request_id	Identifier	required
incarnation	Identifier	required

bounded_input (method)

RequestRef.bounded_input(value: object) -> Any

immutable_fields (method)

RequestRef.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestSelection

from cayu.collaboration import RequestSelection

Bases: ContractValue.

Fields and attributes

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

Name	Type	Default
reference	RequestRef	required
sender	ParticipantSnapshot	required
recipient	ParticipantSnapshot	required
accepted_at_ms	Millis	required
expires_at_ms	Millis	required

bounded_input (method)

RequestSelection.bounded_input(value: object) -> Any

immutable_fields (method)

RequestSelection.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

RequestSnapshot

from cayu.collaboration import RequestSnapshot

Current owner state, independently authenticated against immutable receipts.

Bases: ContractValue.

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
receipt	RequestReceipt	required
permit	PermitCommand	required
revision	Generation	required
state	Literal['open', 'answered', 'failed', 'declined', 'cancelled', 'expired']	required
admission	AdmissionState	required
delivery	Literal['pending', 'excluded', 'published']	required
terminal	RequestControlReceipt | None	required
next_due_at_ms	Counter	required
admission_generation	Annotated[Generation, Field(ge=0)]	0
admission_decision	AdmissionDecision | None	None
admission_operation	OperationRef | None	None
progress	tuple[ProducerProgressReference | RequestProgressReceipt, ...]	Field(default=(), max_length=64)
outcome	RequestOutcomeReceipt | None	None
observations	tuple[RequestObservation, ...]	Field(default=(), max_length=32)
observation_revision	Annotated[Generation, Field(ge=0)]	0
event_sequences	tuple[Generation, ...]	Field(default=(), max_length=64)
producer_operation	OperationRef | None	None
producer_settlement	OperationRef | None	None
clarification	ClarificationFrontier	Field(default_factory=ClarificationFrontier)

bounded_input (method)

RequestSnapshot.bounded_input(value: object) -> Any

immutable_fields (method)

RequestSnapshot.immutable_fields() -> ContractValue

coherent_state (method)

RequestSnapshot.coherent_state() -> RequestSnapshot

Release source · Runtime guarantees · Capability guides