client.subscription

client.subscription — the synchronous surface. Sync owner: WarmHubClient.subscription. Async owner: AsyncWarmHubClient.subscription.

Synchronous methods

bind_credentials

bind_credentials(org_name: str, subscription_name: str, credential_set_name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionBindCredentialsResult

See AsyncSubscriptionNamespace.bind_credentials.

create

create(input: Mapping[str, JsonValue], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionInfo

See AsyncSubscriptionNamespace.create.

get

get(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionInfo

See AsyncSubscriptionNamespace.get.

list

list(org_name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[SubscriptionInfo, ...]

See AsyncSubscriptionNamespace.list.

pause

pause(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionPauseResult

See AsyncSubscriptionNamespace.pause.

remove

remove(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionRemoveResult

See AsyncSubscriptionNamespace.remove.

resume

resume(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionResumeResult

See AsyncSubscriptionNamespace.resume.

reveal

reveal(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionRevealResult

See AsyncSubscriptionNamespace.reveal.

unbind_credentials

unbind_credentials(org_name: str, subscription_name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionUnbindCredentialsResult

See AsyncSubscriptionNamespace.unbind_credentials.

update

update(input: Mapping[str, JsonValue], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionInfo

See AsyncSubscriptionNamespace.update.

Asynchronous methods

bind_credentials

bind_credentials(org_name: str, subscription_name: str, credential_set_name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionBindCredentialsResult

Bind a credential set for outbound webhook authentication.

create

create(input: Mapping[str, JsonValue], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionInfo

Create a webhook subscription.

get

get(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionInfo

Get one subscription by name. Omit repo_name for an org-scoped one.

list

list(org_name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> tuple[SubscriptionInfo, ...]

List subscriptions in a scope. Omit repo_name for the org scope.

pause

pause(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionPauseResult

Pause a subscription.

remove

remove(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionRemoveResult

Delete a subscription.

resume

resume(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionResumeResult

Resume a paused subscription.

reveal

reveal(org_name: str, name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionRevealResult

Reveal the raw webhook URL(s) — a break-glass call, audit-logged.

Reads return only the origin; the raw URL path is a bearer secret. Requires repo:configure.

unbind_credentials

unbind_credentials(org_name: str, subscription_name: str, *, repo_name: str | None = None, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionUnbindCredentialsResult

Unbind the credential set from a subscription.

update

update(input: Mapping[str, JsonValue], *, extra_headers: ExtraHeaders | Unset = UNSET, extra_query: ExtraQuery | Unset = UNSET, extra_body: ExtraBody | Unset = UNSET) -> SubscriptionInfo

Update an existing webhook subscription.

Pass None for a nullable field to CLEAR it. Legacy cron subscriptions cannot be updated — delete them instead.