cayu.delivery.github

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.

approve_github_delivery

from cayu.delivery import approve_github_delivery

approve_github_delivery(request: GitHubPullRequestDeliveryRequest, *, approval_id: str) -> GitHubDeliveryApproval

Release source · Runtime guarantees · Capability guides

github_connector_behavior_fingerprint

from cayu.delivery import github_connector_behavior_fingerprint

github_connector_behavior_fingerprint() -> str

Release source · Runtime guarantees · Capability guides

GITHUB_DELIVERY_RESULT_KIND

from cayu.delivery import GITHUB_DELIVERY_RESULT_KIND

GITHUB_DELIVERY_RESULT_KIND = 'github_pull_request_delivery_result'

Release source · Runtime guarantees · Capability guides

GITHUB_DELIVERY_SCHEMA_VERSION

from cayu.delivery import GITHUB_DELIVERY_SCHEMA_VERSION

GITHUB_DELIVERY_SCHEMA_VERSION = 'cayu.github_delivery.v1'

Release source · Runtime guarantees · Capability guides

github_follow_up_coding_input

from cayu.delivery import github_follow_up_coding_input

github_follow_up_coding_input(result: GitHubDeliveryResult, *, provider_ids: Sequence[str], iteration: int, product_run_id: str, session_id: str, task_id: str) -> GitHubFollowUpCodingInput

Release source · Runtime guarantees · Capability guides

github_pull_request_delivery_request

from cayu.delivery import github_pull_request_delivery_request

github_pull_request_delivery_request(product: CodingProductPublication, remote: RemoteGitDeliveryPublication, *, connector_run_id: str, session_id: str, idempotency_key: str, requested_at: str, repository_alias: str, installation_id: str, account_id: str, mode: Literal['create', 'update'], existing_pull_request_number: int | None, metadata: GitHubPullRequestMetadata, checks: GitHubCheckPolicy, reviews: GitHubReviewPolicy, security: GitHubSecurityAuthority, limits: GitHubDeliveryLimits | None=None) -> GitHubPullRequestDeliveryRequest

Release source · Runtime guarantees · Capability guides

GitHubCheckBundle

from cayu.delivery import GitHubCheckBundle

Bases: _FrozenModel.

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
head_commit	str	required
checks	tuple[GitHubCheckObservation, ...]	required
truncated	StrictBool	False

commit (method)

GitHubCheckBundle.commit(value: str) -> str

Release source · Runtime guarantees · Capability guides

GitHubCheckObservation

from cayu.delivery import GitHubCheckObservation

Bases: _FrozenModel.

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
provider_id	str	required
name	str	required
head_commit	str	required
status	str	required
conclusion	str | None	None
started_at	str | None	None
completed_at	str | None	None
url	str | None	None

identity (method)

GitHubCheckObservation.identity(value: str | None, info) -> str | None

commit (method)

GitHubCheckObservation.commit(value: str) -> str

check_status (method)

GitHubCheckObservation.check_status(value: str) -> str

check_conclusion (method)

GitHubCheckObservation.check_conclusion(value: str | None) -> str | None

timestamp (method)

GitHubCheckObservation.timestamp(value: str | None, info) -> str | None

Release source · Runtime guarantees · Capability guides

GitHubCheckPolicy

from cayu.delivery import GitHubCheckPolicy

Bases: _FrozenModel.

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
required_checks	tuple[str, ...]	required
allow_neutral	StrictBool	False
allow_skipped	StrictBool	False

checks (method)

GitHubCheckPolicy.checks(value: tuple[str, ...]) -> tuple[str, ...]

fingerprint (property)

GitHubCheckPolicy.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

GitHubCheckState

from cayu.delivery import GitHubCheckState

Bases: StrEnum.

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
PENDING	class attribute	'pending'
PASSED	class attribute	'passed'
FAILED	class attribute	'failed'
CANCELLED	class attribute	'cancelled'
TIMED_OUT	class attribute	'timed_out'
MISSING	class attribute	'missing'
SUPERSEDED	class attribute	'superseded'
PROVIDER_AMBIGUOUS	class attribute	'provider_ambiguous'

Release source · Runtime guarantees · Capability guides

GitHubConnectorProfile

from cayu.delivery import GitHubConnectorProfile

Decorators: @dataclass(frozen=True).

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
connector_id	str	required
behavior_fingerprint	str	required
repositories	Mapping[str, GitHubRepositoryConfig]	required

Release source · Runtime guarantees · Capability guides

GitHubConnectorTransport

from cayu.delivery import GitHubConnectorTransport

Decorators: @runtime_checkable.

Bases: Protocol.

observe_ref (method)

async GitHubConnectorTransport.observe_ref(config: GitHubRepositoryConfig, ref: str, limits: GitHubDeliveryLimits) -> str | None

find_pull_requests (method)

async GitHubConnectorTransport.find_pull_requests(config: GitHubRepositoryConfig, *, base_ref: str, head_ref: str, limits: GitHubDeliveryLimits) -> tuple[GitHubPullRequestSnapshot, ...]

get_pull_request (method)

async GitHubConnectorTransport.get_pull_request(config: GitHubRepositoryConfig, number: int, limits: GitHubDeliveryLimits) -> GitHubPullRequestSnapshot

create_pull_request (method)

async GitHubConnectorTransport.create_pull_request(config: GitHubRepositoryConfig, request: GitHubPullRequestDeliveryRequest) -> tuple[GitHubPullRequestSnapshot, str]

update_pull_request (method)

async GitHubConnectorTransport.update_pull_request(config: GitHubRepositoryConfig, request: GitHubPullRequestDeliveryRequest, number: int) -> tuple[GitHubPullRequestSnapshot, str]

set_labels (method)

async GitHubConnectorTransport.set_labels(config: GitHubRepositoryConfig, number: int, labels: tuple[str, ...], limits: GitHubDeliveryLimits) -> str

request_reviewers (method)

async GitHubConnectorTransport.request_reviewers(config: GitHubRepositoryConfig, number: int, reviewers: tuple[str, ...], teams: tuple[str, ...], limits: GitHubDeliveryLimits) -> str

mark_ready (method)

async GitHubConnectorTransport.mark_ready(config: GitHubRepositoryConfig, number: int, limits: GitHubDeliveryLimits) -> str

observe_checks (method)

async GitHubConnectorTransport.observe_checks(config: GitHubRepositoryConfig, head_commit: str, limits: GitHubDeliveryLimits) -> GitHubCheckBundle

observe_reviews (method)

async GitHubConnectorTransport.observe_reviews(config: GitHubRepositoryConfig, number: int, limits: GitHubDeliveryLimits) -> GitHubReviewBundle

Release source · Runtime guarantees · Capability guides

GitHubCredentials

from cayu.delivery import GitHubCredentials

Decorators: @dataclass(frozen=True).

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
credential_profile_id	str	required
token	SecretRef	required
resolver	SecretResolver	required

Release source · Runtime guarantees · Capability guides

GitHubDeliveryAdmissionError

from cayu.delivery import GitHubDeliveryAdmissionError

Immutable provider or delivery authority failed admission.

Bases: GitHubDeliveryError.

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

Release source · Runtime guarantees · Capability guides

GitHubDeliveryApproval

from cayu.delivery import GitHubDeliveryApproval

Bases: _FrozenModel.

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
approval_id	str	required
request_fingerprint	str	required
metadata_fingerprint	str	required
policy_fingerprint	str	required
approved_operations	tuple[GitHubOperation, ...]	required

identity (method)

GitHubDeliveryApproval.identity(value: str) -> str

digest (method)

GitHubDeliveryApproval.digest(value: str, info) -> str

operations (method)

GitHubDeliveryApproval.operations(value: tuple[GitHubOperation, ...]) -> tuple[GitHubOperation, ...]

fingerprint (property)

GitHubDeliveryApproval.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

GitHubDeliveryError

from cayu.delivery import GitHubDeliveryError

Base error for GitHub delivery.

Bases: RuntimeError.

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

Release source · Runtime guarantees · Capability guides

GitHubDeliveryLimits

from cayu.delivery import GitHubDeliveryLimits

Bases: _FrozenModel.

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
timeout_seconds	StrictInt	Field(default=30, ge=1, le=300)
max_response_bytes	StrictInt	Field(default=1024 * 1024, ge=1024, le=4 * 1024 * 1024)
max_polls	StrictInt	Field(default=40, ge=1, le=200)
poll_interval_seconds	StrictInt	Field(default=15, ge=1, le=900)
max_elapsed_seconds	StrictInt	Field(default=3600, ge=1, le=86400)
max_checks	StrictInt	Field(default=100, ge=1, le=100)
max_reviews	StrictInt	Field(default=100, ge=1, le=100)
max_comments	StrictInt	Field(default=100, ge=1, le=100)
max_feedback_bytes	StrictInt	Field(default=4096, ge=256, le=16 * 1024)

Release source · Runtime guarantees · Capability guides

GitHubDeliveryPublication

from cayu.delivery import GitHubDeliveryPublication

Decorators: @dataclass(frozen=True).

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
result	GitHubDeliveryResult	required
artifact	CodingArtifactReference	required

Release source · Runtime guarantees · Capability guides

GitHubDeliveryReconstructionRequiredError

from cayu.delivery import GitHubDeliveryReconstructionRequiredError

Durable GitHub evidence cannot be reconstructed authoritatively.

Bases: GitHubDeliveryError.

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

Release source · Runtime guarantees · Capability guides

GitHubDeliveryRepository

from cayu.delivery import GitHubDeliveryRepository

Immutable requests, approvals, results, and ordered progress receipts.

init (method)

GitHubDeliveryRepository.__init__(store: ArtifactStore) -> None

ensure_request (method)

async GitHubDeliveryRepository.ensure_request(request: GitHubPullRequestDeliveryRequest)

ensure_approval (method)

async GitHubDeliveryRepository.ensure_approval(request, approval)

approval (method)

async GitHubDeliveryRepository.approval(request: GitHubPullRequestDeliveryRequest) -> GitHubDeliveryApproval | None

receipts (method)

async GitHubDeliveryRepository.receipts(request) -> tuple[GitHubLifecycleReceipt, ...]

publish (method)

async GitHubDeliveryRepository.publish(request, result) -> GitHubDeliveryPublication

latest (method)

async GitHubDeliveryRepository.latest(request) -> GitHubDeliveryPublication | None

Release source · Runtime guarantees · Capability guides

GitHubDeliveryResult

from cayu.delivery import GitHubDeliveryResult

Bases: _FrozenModel.

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	Literal['cayu.github_delivery_result.v1']	'cayu.github_delivery_result.v1'
connector_run_id	str	required
session_id	str	required
idempotency_key	str	required
request_fingerprint	str	required
state	GitHubDeliveryState	required
repository_id	str	required
connector_id	str	required
installation_id	str	required
account_id	str	required
credential_profile_id	str	required
egress_profile_id	str	required
policy_fingerprint	str	required
connector_behavior_fingerprint	str	required
approval_policy_fingerprint	str	required
redaction_profile_fingerprint	str	required
metadata_fingerprint	str	required
check_policy_fingerprint	str	required
review_policy_fingerprint	str	required
approval_fingerprint	str | None	None
approval_id	str | None	None
product_result_artifact_id	str	required
product_run_id	str	required
source_workspace_id	str	required
diff_artifact_id	str	required
remote_result_artifact_id	str	required
remote_delivery_id	str	required
product_request_fingerprint	str	required
remote_request_fingerprint	str	required
product_result_sha256	str	required
remote_result_sha256	str	required
source_revision	str	required
diff_sha256	str	required
repository_alias	str	required
base_ref	str	required
base_commit	str	required
head_ref	str	required
head_commit	str	required
pull_request	GitHubPullRequestSnapshot | None	None
checks_state	GitHubCheckState | None	None
review_state	GitHubReviewState | None	None
checks	tuple[GitHubCheckObservation, ...]	()
feedback	tuple[GitHubFeedbackObservation, ...]	()
checks_truncated	StrictBool	False
feedback_truncated	StrictBool	False
required_checks	tuple[str, ...]	required
allowed_operations	tuple[GitHubOperation, ...]	required
review_approval_required	StrictBool	False
required_approvers	tuple[str, ...]	()
minimum_approvals	StrictInt	Field(default=1, ge=1, le=100)
follow_up_allowed	StrictBool	False
max_follow_up_items	StrictInt	Field(default=8, ge=1, le=32)
max_follow_up_iterations	StrictInt	Field(default=3, ge=1, le=20)
limits	GitHubDeliveryLimits	required
operations	tuple[GitHubOperationEvidence, ...]	()
poll_count	StrictInt	Field(default=0, ge=0, le=200)
next_poll_after_seconds	StrictInt | None	Field(default=None, ge=1, le=900)
next_poll_at	str | None	None
reason_code	str | None	None

poll_timestamp (method)

GitHubDeliveryResult.poll_timestamp(value: str | None) -> str | None

identity (method)

GitHubDeliveryResult.identity(value: str | None, info) -> str | None

digest (method)

GitHubDeliveryResult.digest(value: str | None, info) -> str | None

branch (method)

GitHubDeliveryResult.branch(value: str, info) -> str

commit (method)

GitHubDeliveryResult.commit(value: str, info) -> str

approvers (method)

GitHubDeliveryResult.approvers(value: tuple[str, ...]) -> tuple[str, ...]

checks_policy (method)

GitHubDeliveryResult.checks_policy(value: tuple[str, ...]) -> tuple[str, ...]

operations_policy (method)

GitHubDeliveryResult.operations_policy(value: tuple[GitHubOperation, ...]) -> tuple[GitHubOperation, ...]

coherent_evidence (method)

GitHubDeliveryResult.coherent_evidence() -> GitHubDeliveryResult

digest_value (property)

GitHubDeliveryResult.digest_value() -> str

Release source · Runtime guarantees · Capability guides

GitHubDeliveryState

from cayu.delivery import GitHubDeliveryState

Bases: StrEnum.

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
APPROVAL_REQUIRED	class attribute	'approval_required'
DENIED	class attribute	'denied'
PR_CREATED	class attribute	'pr_created'
PR_UPDATED	class attribute	'pr_updated'
CHECKS_PENDING	class attribute	'checks_pending'
CHECKS_PASSED	class attribute	'checks_passed'
CHECKS_FAILED	class attribute	'checks_failed'
CHANGES_REQUESTED	class attribute	'changes_requested'
APPROVED	class attribute	'approved'
CLOSED	class attribute	'closed'
SUPERSEDED	class attribute	'superseded'
CONFLICT	class attribute	'conflict'
RATE_LIMITED	class attribute	'rate_limited'
PROVIDER_UNAVAILABLE	class attribute	'provider_unavailable'
PERMISSION_DENIED	class attribute	'permission_denied'
CANCELLED	class attribute	'cancelled'
FAILED	class attribute	'failed'
PARTIAL	class attribute	'partial'
AMBIGUOUS	class attribute	'ambiguous'
RECONSTRUCTION_REQUIRED	class attribute	'reconstruction_required'

Release source · Runtime guarantees · Capability guides

GitHubFeedbackObservation

from cayu.delivery import GitHubFeedbackObservation

Bases: _FrozenModel.

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
provider_id	str	required
kind	Literal['review', 'review_comment', 'issue_comment']	required
author_login	str	required
author_type	str	required
state	str	required
created_at	str	required
body	str	required
head_commit	str | None	None
url	str | None	None
thread_id	str | None	None
in_reply_to_id	str | None	None
path	str | None	None
line	StrictInt | None	Field(default=None, ge=1)
resolved	StrictBool | None	None

commit (method)

GitHubFeedbackObservation.commit(value: str | None) -> str | None

identity (method)

GitHubFeedbackObservation.identity(value: str | None, info) -> str | None

text (method)

GitHubFeedbackObservation.text(value: str) -> str

timestamp (method)

GitHubFeedbackObservation.timestamp(value: str) -> str

coherent_feedback_state (method)

GitHubFeedbackObservation.coherent_feedback_state() -> GitHubFeedbackObservation

Release source · Runtime guarantees · Capability guides

GitHubFollowUpCodingInput

from cayu.delivery import GitHubFollowUpCodingInput

Bases: _FrozenModel.

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
prior_connector_run_id	str	required
prior_product_run_id	str	required
prior_delivery_id	str	required
head_commit	str	required
iteration	StrictInt	Field(ge=1, le=100)
product_run_id	str	required
session_id	str	required
task_id	str	required
feedback_provider_ids	tuple[str, ...]	required
messages	tuple[str, ...]	required

identity (method)

GitHubFollowUpCodingInput.identity(value: str, info) -> str

commit (method)

GitHubFollowUpCodingInput.commit(value: str) -> str

provider_ids (method)

GitHubFollowUpCodingInput.provider_ids(value: tuple[str, ...]) -> tuple[str, ...]

bounded_messages (method)

GitHubFollowUpCodingInput.bounded_messages(value: tuple[str, ...]) -> tuple[str, ...]

matching_evidence (method)

GitHubFollowUpCodingInput.matching_evidence()

Release source · Runtime guarantees · Capability guides

GitHubLifecycleReceipt

from cayu.delivery import GitHubLifecycleReceipt

Bases: _FrozenModel.

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
connector_run_id	str	required
request_fingerprint	str	required
ordinal	StrictInt	Field(ge=1, le=GITHUB_MAX_RECEIPTS)
state	GitHubDeliveryState	required
result_sha256	str	required
poll_count	StrictInt	Field(ge=0, le=200)

identity (method)

GitHubLifecycleReceipt.identity(value: str) -> str

digest (method)

GitHubLifecycleReceipt.digest(value: str, info) -> str

Release source · Runtime guarantees · Capability guides

GitHubOperation

from cayu.delivery import GitHubOperation

Bases: StrEnum.

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
CREATE_PULL_REQUEST	class attribute	'create_pull_request'
UPDATE_PULL_REQUEST	class attribute	'update_pull_request'
SET_LABELS	class attribute	'set_labels'
REQUEST_REVIEWERS	class attribute	'request_reviewers'
MARK_READY	class attribute	'mark_ready'

Release source · Runtime guarantees · Capability guides

GitHubOperationEvidence

from cayu.delivery import GitHubOperationEvidence

Bases: _FrozenModel.

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	GitHubOperation	required
status	Literal['reconciled', 'succeeded', 'failed', 'ambiguous']	required
request_id	str	required
provider_id	str | None	None

identity (method)

GitHubOperationEvidence.identity(value: str | None, info) -> str | None

Release source · Runtime guarantees · Capability guides

GitHubProviderError

from cayu.delivery import GitHubProviderError

Safe classified provider failure without response content.

Bases: GitHubDeliveryError.

init (method)

GitHubProviderError.__init__(code: str, *, status_code: int | None=None, retryable: bool=False, ambiguous: bool=False, request_id: str | None=None) -> None

Release source · Runtime guarantees · Capability guides

GitHubPullRequestConnector

from cayu.delivery import GitHubPullRequestConnector

Mutate one bound PR and durably observe one exact-head poll per call.

init (method)

GitHubPullRequestConnector.__init__(profile: GitHubConnectorProfile, *, repository: GitHubDeliveryRepository, transport: GitHubConnectorTransport, clock=None) -> None

seal (method)

GitHubPullRequestConnector.seal() -> None

Reject new calls and stop subsequent effects in retained calls.

aclose (method)

async GitHubPullRequestConnector.aclose(*, timeout_s: float=30.0) -> bool

Seal and observe local quiescence without cancelling owned mutations.

False (or cancellation) requires retaining this connector and its loop; a later call may observe settlement. True is not proof of remote success. Shared transports and artifact stores are not closed by this method.

run (method)

async GitHubPullRequestConnector.run(request: GitHubPullRequestDeliveryRequest, product: CodingProductPublication, remote: RemoteGitDeliveryPublication, *, approval: GitHubDeliveryApproval | None=None) -> GitHubDeliveryPublication

Release source · Runtime guarantees · Capability guides

GitHubPullRequestDeliveryRequest

from cayu.delivery import GitHubPullRequestDeliveryRequest

Bases: _FrozenModel.

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	Literal['cayu.github_delivery.v1']	GITHUB_DELIVERY_SCHEMA_VERSION
connector_run_id	str	required
session_id	str	required
idempotency_key	str	required
requested_at	str	required
source	GitHubSourceAuthority	required
repository	GitHubRepositoryAuthority	required
mode	Literal['create', 'update']	required
existing_pull_request_number	StrictInt | None	Field(default=None, ge=1)
metadata	GitHubPullRequestMetadata	required
checks	GitHubCheckPolicy	required
reviews	GitHubReviewPolicy	Field(default_factory=GitHubReviewPolicy)
security	GitHubSecurityAuthority	required
limits	GitHubDeliveryLimits	Field(default_factory=GitHubDeliveryLimits)
merge	Literal[False]	False

identity (method)

GitHubPullRequestDeliveryRequest.identity(value: str, info) -> str

timestamp (method)

GitHubPullRequestDeliveryRequest.timestamp(value: str) -> str

coherent_mode (method)

GitHubPullRequestDeliveryRequest.coherent_mode()

fingerprint (property)

GitHubPullRequestDeliveryRequest.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

GitHubPullRequestMetadata

from cayu.delivery import GitHubPullRequestMetadata

Bases: _FrozenModel.

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
title	str	required
body	str	''
labels	tuple[str, ...]	()
reviewers	tuple[str, ...]	()
teams	tuple[str, ...]	()
draft	StrictBool	True

title_text (method)

GitHubPullRequestMetadata.title_text(value: str) -> str

body_text (method)

GitHubPullRequestMetadata.body_text(value: str) -> str

names (method)

GitHubPullRequestMetadata.names(value: tuple[str, ...], info) -> tuple[str, ...]

logins (method)

GitHubPullRequestMetadata.logins(value: tuple[str, ...]) -> tuple[str, ...]

fingerprint (property)

GitHubPullRequestMetadata.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

GitHubPullRequestSnapshot

from cayu.delivery import GitHubPullRequestSnapshot

Bases: _FrozenModel.

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
number	StrictInt	Field(ge=1)
node_id	str	required
url	str	required
state	Literal['open', 'closed']	required
draft	StrictBool	required
merged	StrictBool	False
mergeable	StrictBool | None	None
mergeable_state	str | None	None
base_ref	str	required
base_commit	str	required
head_ref	str	required
head_commit	str	required
title	str	required
body	str	''
labels	tuple[str, ...]	()

identity (method)

GitHubPullRequestSnapshot.identity(value: str | None, info) -> str | None

branch (method)

GitHubPullRequestSnapshot.branch(value: str, info) -> str

commit (method)

GitHubPullRequestSnapshot.commit(value: str, info) -> str

text (method)

GitHubPullRequestSnapshot.text(value: str, info) -> str

canonical_labels (method)

GitHubPullRequestSnapshot.canonical_labels(value: tuple[str, ...]) -> tuple[str, ...]

coherent_state (method)

GitHubPullRequestSnapshot.coherent_state() -> GitHubPullRequestSnapshot

Release source · Runtime guarantees · Capability guides

GitHubRepositoryAuthority

from cayu.delivery import GitHubRepositoryAuthority

Bases: _FrozenModel.

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
repository_id	str	required
repository_alias	str	required
installation_id	str	required
account_id	str	required
base_ref	str	required
expected_base_commit	str	required
head_ref	str	required
head_commit	str	required

identity (method)

GitHubRepositoryAuthority.identity(value: str, info) -> str

branch_ref (method)

GitHubRepositoryAuthority.branch_ref(value: str, info) -> str

commit (method)

GitHubRepositoryAuthority.commit(value: str, info) -> str

Release source · Runtime guarantees · Capability guides

GitHubRepositoryConfig

from cayu.delivery import GitHubRepositoryConfig

Decorators: @dataclass(frozen=True).

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
alias	str	required
repository_id	str	required
installation_id	str	required
account_id	str	required
api_base_url	str	required
owner	str	required
name	str	required
credential_profile_id	str	required
egress_profile_id	str	required
credentials	GitHubCredentials	required

Release source · Runtime guarantees · Capability guides

GitHubRestTransport

from cayu.delivery import GitHubRestTransport

Fixed-operation, bounded GitHub REST transport with vault-backed auth.

init (method)

GitHubRestTransport.__init__(client: httpx.AsyncClient | None=None) -> None

observe_ref (method)

async GitHubRestTransport.observe_ref(config, ref, limits)

find_pull_requests (method)

async GitHubRestTransport.find_pull_requests(config, *, base_ref, head_ref, limits)

get_pull_request (method)

async GitHubRestTransport.get_pull_request(config, number, limits)

create_pull_request (method)

async GitHubRestTransport.create_pull_request(config, request)

update_pull_request (method)

async GitHubRestTransport.update_pull_request(config, request, number)

set_labels (method)

async GitHubRestTransport.set_labels(config, number, labels, limits)

request_reviewers (method)

async GitHubRestTransport.request_reviewers(config, number, reviewers, teams, limits)

mark_ready (method)

async GitHubRestTransport.mark_ready(config, number, limits)

observe_checks (method)

async GitHubRestTransport.observe_checks(config, head_commit, limits)

observe_reviews (method)

async GitHubRestTransport.observe_reviews(config, number, limits)

Release source · Runtime guarantees · Capability guides

GitHubReviewBundle

from cayu.delivery import GitHubReviewBundle

Bases: _FrozenModel.

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
feedback	tuple[GitHubFeedbackObservation, ...]	required
truncated	StrictBool	False

Release source · Runtime guarantees · Capability guides

GitHubReviewPolicy

from cayu.delivery import GitHubReviewPolicy

Bases: _FrozenModel.

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
approval_required	StrictBool	False
required_approvers	tuple[str, ...]	()
minimum_approvals	StrictInt	Field(default=1, ge=1, le=100)
allow_follow_up	StrictBool	False
max_follow_up_items	StrictInt	Field(default=8, ge=1, le=32)
max_follow_up_iterations	StrictInt	Field(default=3, ge=1, le=20)

approvers (method)

GitHubReviewPolicy.approvers(value: tuple[str, ...]) -> tuple[str, ...]

coherent_approval_policy (method)

GitHubReviewPolicy.coherent_approval_policy() -> GitHubReviewPolicy

fingerprint (property)

GitHubReviewPolicy.fingerprint() -> str

Release source · Runtime guarantees · Capability guides

GitHubReviewState

from cayu.delivery import GitHubReviewState

Bases: StrEnum.

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
NONE	class attribute	'none'
APPROVED	class attribute	'approved'
CHANGES_REQUESTED	class attribute	'changes_requested'
COMMENTED	class attribute	'commented'

Release source · Runtime guarantees · Capability guides

GitHubSecurityAuthority

from cayu.delivery import GitHubSecurityAuthority

Bases: _FrozenModel.

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
connector_id	str	required
connector_behavior_fingerprint	str	required
credential_profile_id	str	required
egress_profile_id	str	required
policy_fingerprint	str	required
approval_policy_fingerprint	str	required
redaction_profile_fingerprint	str	required
allowed_operations	tuple[GitHubOperation, ...]	required

identity (method)

GitHubSecurityAuthority.identity(value: str, info) -> str

digest (method)

GitHubSecurityAuthority.digest(value: str, info) -> str

operations (method)

GitHubSecurityAuthority.operations(value: tuple[GitHubOperation, ...]) -> tuple[GitHubOperation, ...]

Release source · Runtime guarantees · Capability guides

GitHubSourceAuthority

from cayu.delivery import GitHubSourceAuthority

Bases: _FrozenModel.

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
product_result_artifact_id	str	required
product_result_sha256	str	required
product_request_fingerprint	str	required
product_run_id	str	required
source_workspace_id	str	required
source_revision	str	required
diff_artifact_id	str	required
diff_sha256	str	required
remote_result_artifact_id	str	required
remote_result_sha256	str	required
remote_request_fingerprint	str	required
remote_delivery_id	str	required

identity (method)

GitHubSourceAuthority.identity(value: str, info) -> str

digest (method)

GitHubSourceAuthority.digest(value: str, info) -> str

Release source · Runtime guarantees · Capability guides