subscription
Accessed as client.repos.subscription; the async client mirrors it.
ReposSubscription
The repos.subscription namespace.
delete
delete(owner: str, repo: str) -> None
Unwatch a repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: userCurrentDeleteSubscription
get
get(owner: str, repo: str) -> WatchInfo
Check if the current user is watching a repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
WatchInfo
|
WatchInfo. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: userCurrentCheckSubscription
update
update(owner: str, repo: str) -> WatchInfo
Watch a repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
WatchInfo
|
WatchInfo. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: userCurrentPutSubscription
AsyncReposSubscription
The repos.subscription namespace.
delete
delete(owner: str, repo: str) -> None
Unwatch a repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: userCurrentDeleteSubscription
get
get(owner: str, repo: str) -> WatchInfo
Check if the current user is watching a repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
WatchInfo
|
WatchInfo. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: userCurrentCheckSubscription
update
update(owner: str, repo: str) -> WatchInfo
Watch a repo.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
owner
|
str
|
owner of the repo |
required |
repo
|
str
|
name of the repo |
required |
Returns:
| Type | Description |
|---|---|
WatchInfo
|
WatchInfo. |
Raises:
| Type | Description |
|---|---|
NotFoundError
|
|
Operation ID: userCurrentPutSubscription